Skip to content

GetOrder returns a single order by one of its identifiers, in the same lean ShippedOrder view ListShippedOrders returns. Unlike ListShippedOrders it applies no status filter, returning the order whatever its status, so a caller (e.g. the shipment-confirmation CLI) can fetch a specific order by channel order id, Zentail order number, or Zentail order id. The storefront / integration is resolved from the API token; a channel_order_id lookup is scoped to that integration. Returns NOT_FOUND when no order matches.

You call thisScope not enforced

GET
/v2/storefront/order
curl --request GET \
--url https://api.zentail.com/v2/storefront/order \
--header 'Authorization: Bearer <token>'
channelOrderId
string

The order ID used by the channel when the order was created (reseller_order_id), scoped to the token’s integration.

orderNumber
string format: int64

The internal Zentail order number (order_number).

purchaseOrderId
string format: int64

The internal Zentail order id (purchase_order_id).

A successful response.

Media typeapplication/json

GetOrderResponse carries the requested order in the lean ShippedOrder view.

object
order

ShippedOrder is a lean view of a shipped / partially-shipped order, carrying only the fields a shipment-confirmation poller needs.

object
channelOrderId

The order ID used by the channel when the order was created.

string
status

Internal Zentail order status: SHIPPED or PARTIALLY_SHIPPED.

string
salesChannelStatus

The sales-channel status (reseller_status column).

string
lastUpdatedTs

When the order was last updated.

string format: date-time
orderNumber

The internal Zentail order number.

string format: int64
marketplaceId

The sales channel’s marketplace id (e.g. the Amazon marketplace).

string
standardServiceLevel

The standardized requested service level, used as a carrier-mapping fallback when a package carries no service level of its own.

string
lineItems

Order-level line items, carrying the channel line-item id and ordered quantity needed to map shipped packages back to channel order items.

Array<object>

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
lineItemId

The Zentail line item id (purchase_order_product id), as a string to match the channel-facing representation.

string
channelLineItemId

The channel’s own line item id, when the channel assigns one.

string
sku

The SKU for this line.

string
quantity

The ordered quantity for this line.

string format: int64
channelSku

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.

string
packages

Shipped packages (one per tracking number) with their per-line shipped quantities — the unit of shipment confirmation.

Array<object>

ShippedOrderPackage is a single shipped package (one tracking number) with the line quantities it shipped.

object
packageId

The Zentail package id.

string format: int64
carrier

Shipping carrier.

string
serviceLevel

Carrier service level.

string
tracking

Tracking number.

string
shippedTs

When the package shipped.

string format: date-time
items

The line items (and shipped quantities) in this package.

Array<object>

ShippedOrderPackageItem is one line’s shipped quantity within a package.

object
lineItemId

The Zentail line item id (purchase_order_product id); matches ShippedOrderLineItem.line_item_id.

string
sku

The SKU for this line.

string
quantity

The quantity of this line shipped in this package.

string format: int64
channelSku

The SKU the channel itself listed this line under; see ShippedOrderLineItem.channel_sku.

string
Examplegenerated
{
"order": {
"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"
}
]
}
]
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}

Sourceapi-proto@afdb30cc via [email protected]

Built0c509dd3

This page describes the source document as deployed: the version sales-orders pinned in its release r2026.09.24. A change merged upstream shows up here once it has deployed and the pins are next refreshed.

API changelog