Fulfillment Orders

Create one or more FulfillmentOrders and FulfillmentOrderLineItems for an OrderDeliveryGroupSummary, which defines a delivery method and recipient for an OrderSummary. You specify the OrderItemSummaries to allocate, which can be fulfilled from different locations. Specifying multiple fulfillment groups creates one FulfillmentOrder for each location. For each OrderItemSummary, a FulfillmentOrderLineItem is created and assigned to the corresponding FulfillmentOrder.
Resource
/commerce/fulfillment/fulfillment-orders
Available version
48.0
HTTP methods
POST
Request body for POST
Fulfillment Order Input
Root XML tag
<fulfillmentOrderInput>
JSON example
{  
  "defaultActivationStatus":"Allocated",
  "orderSummaryId":"1Osxx0000000000001",
  "orderDeliveryGroupSummaryId":"0ag7Q000000xPYgQAM",
  "fulfillmentGroups":[  
    {  
      "fulfilledFromLocationId":"131xx00000000W0001",
      "fulfillmentType":"warehouse",
      "orderItemSummaries":[  
        {  
          "orderItemSummaryId":"10uxx00000000W0001",
          "quantity":3
        },
        {  
          "orderItemSummaryId":"10uxx00000000W0002",
          "quantity":1
        }
      ]
    }
  ]
}
Properties
Name Type Description Required or Optional Available Version
defaultActivationStatus String

Default activation status for a new fulfillment order. If you don't specify a value, the default value is Allocated, which belongs to the Activated status category. This default can be changed, but the replacement status must also have a status category of Activated.

Optional 58.0
fulfillmentGroups Fulfillment Group Input[] List of fulfillment groups that specify the OrderItemSummaries and fulfillment locations. Required 48.0
orderDeliveryGroup​SummaryId String ID of the OrderDeliveryGroupSummary. Required 48.0
orderSummaryId String ID of the OrderSummary. Required 48.0
Response body for POST
  • When the HTTP status code indicates success, the response body is a Fulfillment Order Output. The response body can still indicate processing errors.
  • When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The output property is a Fulfillment Order Output, and the value of the enhancedErrorType property can be ignored.