Skip to main content
GET
Get shipment statistics summary
Returns aggregate counts of the store’s shipments grouped into a small summary: total shipments, pending (pending or in transit), delivered, and canceled (failed or returned). Requires the READ_SHIPPING scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Response

Get shipment statistics summary.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

Aggregate shipment counts for the store.