MobiariDocs
Admin APIShipments

List an order's shipments

GET
/stores/{store_id}/orders/{order_id}/shipments

Oldest first, each with its contents and tracking. The order itself (GET .../orders/{order_id}) carries the same list.

Authorization

bearer_auth
AuthorizationBearer <token>

Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.

In: header

Path Parameters

store_id*string

Store id

Formatuuid
order_id*string

Order id

Formatuuid

Query Parameters

limit?integer

Page size, 1 to 200. Defaults to 50.

Formatint64
Range1 <= value <= 200
cursor?string

next_cursor from the previous page. Omit for the first page.

offset?integer

Rows to skip, for UIs that jump to a page number. Ignored when cursor is set. Prefer cursor for walking a whole list.

Formatint64
Range0 <= value
include_total?boolean

Also return total, the count of all matching rows. Costs an extra query; leave off when you only walk pages.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/shipments?limit=50"
{
  "data": [
    {
      "carrier_name": "string",
      "cdf_price_id": 0,
      "cdf_quotation_code": "string",
      "cost_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "delivered_at": "2019-08-24T14:15:22Z",
      "freight_external_order_code": "string",
      "freight_payer": "string",
      "freight_provider_code": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "items": [
        {
          "order_item_id": "c3e40b5c-b9ae-413a-b96e-5aa0514f5ae6",
          "ordered_quantity": 0,
          "quantity": 0,
          "sku": "string",
          "title": "string"
        }
      ],
      "notes": "string",
      "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
      "shipped_at": "2019-08-24T14:15:22Z",
      "status": "draft",
      "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
      "tracking_code": "string",
      "tracking_events": [
        {
          "comment": "string",
          "datetime": "string",
          "event": "string",
          "occurred_at": "2019-08-24T14:15:22Z"
        }
      ],
      "tracking_json": {},
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string",
  "total": 0
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}