Skip to main content
GET
/
shipments
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": 123,
  "currency": "<string>",
  "deliver_by": "2023-12-25",
  "delivery_date": "2023-12-25",
  "estimated_ship_date": "2023-12-25",
  "shipped_date": "2023-12-25",
  "received_date": "2023-12-25",
  "status": "not_shipped",
  "notes": "<string>",
  "tracking_number": "<string>",
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "spec_quantity": 123,
      "ordered": 123,
      "received": 123,
      "shipped": 123
    }
  ],
  "shipping_client": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "supplier": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "purchase_order_ids": [
    123
  ]
}

Authorizations

authorization
string
header
required

Path Parameters

id
integer
required

Response

OK

id
integer
currency
string | null
deliver_by
string<date> | null
delivery_date
string<date> | null
estimated_ship_date
string<date> | null
shipped_date
string<date> | null
received_date
string<date> | null
status
enum<string>
Available options:
not_shipped,
arrival_expected,
received
notes
string | null
tracking_number
string | null
items
object[]
shipping_client
object
supplier
object
purchase_order_ids
integer[]