ListShippedOrders returns orders whose internal Zentail status is SHIPPED or PARTIALLY_SHIPPED, for shipment-confirmation polling.
You call thisScope not enforced
const url = 'https://api.zentail.com/v2/storefront/orders/shipped';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.zentail.com/v2/storefront/orders/shipped \ --header 'Authorization: Bearer <token>'The internal status filter is enforced server-side; callers cannot request other statuses. Channel-fulfilled orders (FBA / AFN) are excluded by default, since the seller does not confirm shipment for them; set include_channel_fulfilled_orders to include them. Results are keyset-paginated: pass the next_page_cursor from the previous response to fetch the next page. An empty next_page_cursor means there are no more results. The storefront / integration is resolved from the API token, not the request.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”Only return orders whose last update is at or after this time (inclusive). Maps to the channel-order last update timestamp; named to match the existing salesOrder list wording (lastUpdatedTs).
Optional additional filter on the sales-channel status (the reseller_status column), e.g. the channel’s own shipped status. The internal SHIPPED / PARTIALLY_SHIPPED filter is always applied regardless of this value.
Opaque pagination cursor. Empty for the first page; otherwise the next_page_cursor returned by the previous response.
Maximum number of orders to return. Zero or negative uses the server default; the server may clamp to a maximum.
Include channel-fulfilled (FBA / AFN) orders. Defaults to false: such orders are excluded because the seller does not confirm shipment for them. Set true to include them anyway.
Responses
Section titled “ Responses ”A successful response.
ListShippedOrdersResponse is a single page of shipped orders.
object
ShippedOrder is a lean view of a shipped / partially-shipped order, carrying only the fields a shipment-confirmation poller needs.
object
The order ID used by the channel when the order was created.
Internal Zentail order status: SHIPPED or PARTIALLY_SHIPPED.
The sales-channel status (reseller_status column).
When the order was last updated.
The internal Zentail order number.
The sales channel’s marketplace id (e.g. the Amazon marketplace).
The standardized requested service level, used as a carrier-mapping fallback when a package carries no service level of its own.
Order-level line items, carrying the channel line-item id and ordered quantity needed to map shipped packages back to channel order items.
ShippedOrderLineItem is an order-level line item (not package-scoped), carrying the identifiers needed to resolve a shipped package line back to the channel’s order item.
object
The Zentail line item id (purchase_order_product id), as a string to match the channel-facing representation.
The channel’s own line item id, when the channel assigns one.
The SKU for this line.
The ordered quantity for this line.
The SKU the channel itself listed this line under (reseller_suggested_sku). Differs from sku whenever the line is an alias of a catalog product, so channel-side lookups keyed on the seller SKU must use this rather than sku.
Shipped packages (one per tracking number) with their per-line shipped quantities — the unit of shipment confirmation.
ShippedOrderPackage is a single shipped package (one tracking number) with the line quantities it shipped.
object
The Zentail package id.
Shipping carrier.
Carrier service level.
Tracking number.
When the package shipped.
The line items (and shipped quantities) in this package.
ShippedOrderPackageItem is one line’s shipped quantity within a package.
object
The Zentail line item id (purchase_order_product id); matches ShippedOrderLineItem.line_item_id.
The SKU for this line.
The quantity of this line shipped in this package.
The SKU the channel itself listed this line under; see ShippedOrderLineItem.channel_sku.
The cursor token for the next page of results. If empty, there are no more results.
Examplegenerated
{ "orders": [ { "channelOrderId": "example", "status": "example", "salesChannelStatus": "example", "lastUpdatedTs": "2026-04-15T12:00:00Z", "orderNumber": "example", "marketplaceId": "example", "standardServiceLevel": "example", "lineItems": [ { "lineItemId": "example", "channelLineItemId": "example", "sku": "example", "quantity": "example", "channelSku": "example" } ], "packages": [ { "packageId": "example", "carrier": "example", "serviceLevel": "example", "tracking": "example", "shippedTs": "2026-04-15T12:00:00Z", "items": [ { "lineItemId": "example", "sku": "example", "quantity": "example", "channelSku": "example" } ] } ] } ], "nextPageCursor": "example"}default
Section titled “default”An unexpected error response.
object
object
Examplegenerated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}