List all shipments

How to fetch a collection of shipments via API

To fetch a collection of shipments, send a GET request to the /api/shipments endpoint.

Request

GET https://yourdomain.commercelayer.io/api/shipments

Example

The following request fetches a collection of shipments:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/shipments/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of shipments can be sorted by the following fields:

Attributes

  • number

  • status

  • cost_amount_cents

  • get_rates_started_at

  • get_rates_completed_at

  • purchase_started_at

  • purchase_completed_at

  • purchase_failed_at

  • on_hold_at

  • picking_at

  • packing_at

  • ready_to_ship_at

  • shipped_at

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • order

  • shipping_category

  • inventory_stock_location

  • stock_location

  • shipping_method

Filterable fields

The list of shipments can be filtered by the following fields:

Attributes

  • number

  • status

  • cost_amount_cents

  • get_rates_started_at

  • get_rates_completed_at

  • purchase_started_at

  • purchase_completed_at

  • purchase_failed_at

  • on_hold_at

  • picking_at

  • packing_at

  • ready_to_ship_at

  • shipped_at

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • order

  • shipping_category

  • inventory_stock_location

  • stock_location

  • origin_address

  • shipping_address

  • shipping_method

  • stock_line_items

  • stock_transfers

  • parcels

  • attachments

  • events

  • tags

Last updated