Skip to content

PostFulfillmentOrder

Field Type Required Description
orderNumber FOOrderNumber Unique fulfillment order number
max length 50
externalCode ExternalCode external order id
min length 1
salesOrderNumber string yes
locationCode string yes Location code which should fulfill the order
customerId string yes Customer identifier
externalCustomerNumber ExternalCustomerNumber A customer number / reference to an external system.
channel object
type FulfillmentOrderType yes one of: directShip, BOPIS, ROPIS
routeType RouteType yes one of: standardDirectShip, standardPickup, standardReserve
status FulfillmentOrderStatus one of: new, requested, accepted, inProgress, picked, packed, ready, hold, checkedIn, canceled, rejected, fulfilled · default: "new"
sequenceId integer If not provided it will automatically be set to the highest so far incremented by 1.
expedited boolean
subTotal number yes format: float · default: 0
taxAmount TaxAmount Tax amount of the first tax group (e.g. for german taxes this is an absolut number based on either 7% or 19% of the order total; the order total is 10.00 EUR so the taxAmount is 10.00 EUR * 0.19 = 1.9 EUR)
format: float · default: 0
tax2Amount Tax2Amount Tax amount of the second tax group (can be used for additional taxes like for example US state taxes)
format: float · default: 0
shippingTotal number format: float
total number yes format: float
localeCode LocaleCode yes max length 5 · min length 2
currencyCode CurrencyCode yes max length 3 · min length 3
notes Notes Customer notes where the shopper can provide special instructions. The notes are shown in the In-Store App & Admin.
max length 1000
specialInstructions SpecialInstructions Special instructions of the order. It can contain special shipping or fulfillment instructions
fulfillmentOrderAddress FulfillmentOrderAddress
fulfillments array[CreateFulfillment]
lineItems array[PostFOLineItem] yes
fulfillmentSlot FulfillmentSlot
submitDate SubmitDate Date when the order was submitted by the customer
format: date-time
acceptDate AcceptDate Date when the order status was changed to accepted
format: date-time
readyDate ReadyDate Date when the order status was changed to ready
format: date-time
completeDate CompleteDate Date when the order status was changed to completed
format: date-time
{
"orderNumber": "1293747-0001",
"externalCode": "000000274",
"salesOrderNumber": "1293747",
"locationCode": "DERetail001",
"customerId": "55c98b8e-1100-497c-8df6-4b4f0353ab2a",
"externalCustomerNumber": "C1756793",
"channel": {
"code": "USRTL"
},
"type": "directShip",
"routeType": "standardDirectShip",
"status": "new",
"sequenceId": 0,
"expedited": true
}