Order API
TypeOrderFulfillment2
Represents a fulfillment (shipment) of order items.
Fulfillments track the shipping and delivery status of items in an order. This allows for delayed point accrual based on fulfillment or delivery events.
| Kind | Type |
|---|---|
| Used in | EstimateAccrual1, UpdateOrders4 |
Properties
-
idstring optionalID of the fulfillment in the ecommerce system
This is the unique identifier for the fulfillment/shipment in your system.
-
When the fulfillment was created
This is typically when items were packed and prepared for shipping.
-
When the shipment was picked up by the carrier
This marks when the items actually left your facility and are in transit to the customer.
-
deliveredboolean optionalWhether the shipment has been delivered
Set to true when you have confirmation that the customer received the items.
-
When the shipment was delivered to the customer
The actual delivery timestamp, if known. Only relevant when
deliveredis true. -
Which items and quantities are included in this fulfillment
This allows tracking partial fulfillments where only some items or quantities from the order are shipped in this particular shipment.