Skip to content

SimpleFulfillmentOrder

Field Type Required Description
orderNumber FOOrderNumber Unique fulfillment order number
max length 50
externalCode ExternalCode external order id
min length 1
posTransactionId PosTransactionId Transaction id of the POS
cancellationReason CancellationReason one of: expired, declined, newPurchase, tooBusy, unavailableProducts, other
heldUntil HeldUntil Date until which order is held for pickup.
format: date-time
pickupReminderApplicableAt PickupReminderApplicableAt Date when pickup reminder can be sent out.
format: date-time
salesOrderNumber string
locationCode string Location code which should fulfill the order
type FulfillmentOrderType one of: directShip, BOPIS, ROPIS
customerId string Customer identifier
externalCustomerNumber ExternalCustomerNumber A customer number / reference to an external system.
routeType RouteType one of: standardDirectShip, standardPickup, standardReserve
expedited boolean
status FulfillmentOrderStatus one of: new, requested, accepted, inProgress, picked, packed, ready, hold, checkedIn, canceled, rejected, fulfilled · default: "new"
subTotal number format: float
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
total number format: float
shippingTotal number format: float
localeCode LocaleCode max length 5 · min length 2
currencyCode CurrencyCode 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
scheduledPickupTime string format: string
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
fulfillmentOrderAddress FulfillmentOrderAddress
salesOrder SimpleSalesOrder
lineItems array[FOLineItem]
fulfillments array[Fulfillment]
{
"orderNumber": "1293747-0001",
"externalCode": "000000274",
"posTransactionId": "528a-1",
"cancellationReason": "expired",
"heldUntil": "2019-10-05T09:02:57.733Z",
"pickupReminderApplicableAt": "2019-09-02T09:02:57.733Z",
"salesOrderNumber": "1293747",
"locationCode": "DERetail001",
"type": "directShip",
"customerId": "55c98b8e-1100-497c-8df6-4b4f0353ab2a",
"externalCustomerNumber": "C1756793",
"routeType": "standardDirectShip"
}