Order Fulfillment Lifecycle
This recipe was an interactive walkthrough in the previous portal. Each step below names the API call it makes; open it in the API Reference to try it.
Overview
Step 1: List Orders
Search your order history to find orders on your account. The response contains a page of orders,
API call: getOrders
Step 2: Get Order Detail
Retrieve the full detail for a single order, including its orderLines[] — each line's lineNumber
API call: getOrder
Example arguments:
{
path: { purchaseOrderId },
}Step 3: Acknowledge Order
Acknowledge the order to confirm you have received and accepted it for fulfillment. This is required
API call: acknowledgeOrder
Example arguments:
{
path: { purchaseOrderId },
body: {
orderLines: [
{
lineNumber: lineNumber ?? "1",
statusCode: "Acknowledged",
},
],
},
}Step 4: Ship Order
Mark the order's line items as shipped by providing carrier and tracking information. This triggers
API call: shipOrderLines
Example arguments:
{
path: { purchaseOrderId },
body: {
orderLines: [
{
lineNumber: lineNumber ?? "1",
trackingInfo: {
carrier: "UPS",
trackingNumber: "1Z999AA10123456784",
shippedDate: new Date().toISOString(),
},
},
],
},
}Step 5: Deliver Order
Record the terminal Delivered event for the order's lines, optionally with proof-of-delivery details
API call: deliverOrderLines
Example arguments:
{
path: { purchaseOrderId },
body: {
orderLines: [
{
lineNumber: lineNumber ?? "1",
trackingNumber: trackingNumber,
deliveredDate: new Date().toISOString(),
},
],
},
}Step 6: Verify Final Status
Re-fetch the order one more time to confirm the full lifecycle completed — the orderStatus field
API call: getOrder
Example arguments:
{
path: { purchaseOrderId },
}