Order API
OrderItemFulfillment2
Specifies which order item and quantity is included in a fulfillment.
This type is used within fulfillments to track partial shipments where only some items or quantities from an order are included in a particular shipment.
Properties
id
stringrequiredThe ID of the order item being fulfilled
This should match the
id
field of an item in the order'sitems
array.Example:
"xyz101"
qty
integerrequiredThe quantity of this item included in the fulfillment
For partial fulfillments, this may be less than the total quantity ordered. For example, if a customer ordered 5 units but only 3 are being shipped now, this would be 3.
Example:
2
Examples
Item Shipped
{ "id": "xyz101", "qty": 2 }