GET
/
shipments
List Shipments
curl --request GET \
  --url https://api.wizcommerce.com/v1/shipments \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "reference_id": "123",
      "order_id": "123",
      "created_at": "2021-01-01T00:00:00Z",
      "status": "shipped",
      "tracking_info": {
        "tracking_number": "123",
        "tracking_url": "https://www.google.com",
        "delivery_partner": "Fedex"
      },
      "shipment_items": [
        {
          "id": "123",
          "sku_id": "123",
          "quantity": 10
        }
      ],
      "updated_at": "2021-01-01T00:00:00Z",
      "note": "Handle with care"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

reference_ids
string[]
Maximum length: 255
page
integer
Required range: x >= 1
shipment_status
enum<string>
Available options:
shipped,
created,
fulfilled
page_size
integer
Required range: 1 <= x <= 100
sort_by
enum<string>
Available options:
created_at,
updated_at
sort
enum<string>
Available options:
asc,
desc

Response

200
application/json

OK

The response is of type object.