Skip to main content
GET
/
v1
/
shipping
/
shipments
/
{id}
/
reservations
Get Shipment Reservations
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/shipping/shipments/{id}/reservations \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "type": "Reservation",
      "id": 12345,
      "quantity": 2.5,
      "qty_picked": 0,
      "is_locked": true,
      "location": {
        "type": "Location",
        "id": 42
      },
      "item": {
        "type": "ShipmentItem",
        "id": 123,
        "product": {
          "type": "Product",
          "id": 3
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer
required

The shipment ID

Required range: x >= 1

Query Parameters

​
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

​
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

​
sort
string

The default sort order is descending by primary key (sort=-id).

Using the sorting syntax, the following fields are available for sorting:

  • id
  • quantity
  • qty_picked
​
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • location_id
  • product_id
  • qty
  • qty_picked
  • is_locked
​
fields
enum<string>[]

Specify additional fields to include in the response

​
fields:item
enum<string>[]

Specify additional fields of the ShipmentItem object to be included in the response. See the selecting fields page for more information.

​
fields:item.product
enum<string>[]

Specify additional fields of the Product objects to be included in the response. See the selecting fields page for more information.

​
fields:item.order_item
enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

​
fields:location
enum<string>[]

Specify additional fields of the Location object to be included in the response. See the selecting fields page for more information.

​
fields:location.lot
enum<string>[]

Specify additional fields of the Lot object to be included in the response. See the selecting fields page for more information.

​
fields:location.location_type
enum<string>[]

Specify additional fields of the LocationType object (via Location) to be included in the response. See the selecting fields page for more information.

​
fields:location.product
enum<string>[]

Specify additional fields of the Product object (via Location) to be included in the response. See the selecting fields page for more information.

​
fields:location.rack
enum<string>[]

Specify additional fields of the Rack object (via Location) to be included in the response. See the selecting fields page for more information.

Response

A dictionary with a collection property that contains a list of Reservation objects for the specified shipment.

​
collection
Reservation · object[]

A list of Reservation objects.