List all parcels

How to fetch a collection of parcels via API

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

Request

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

Example

The following request fetches a collection of parcels:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/parcels/' \
  -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 parcels can be sorted by the following fields:

Attributes

  • weight

  • tracking_status

  • tracking_status_updated_at

  • carrier_weight_oz

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • shipment

  • package

Filterable fields

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

Attributes

  • weight

  • contents_explanation

  • shipping_label_url

  • shipping_label_file_type

  • shipping_label_size

  • shipping_label_resolution

  • tracking_number

  • tracking_status

  • tracking_status_detail

  • tracking_status_updated_at

  • carrier_weight_oz

  • incoterm

  • delivery_confirmation

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • shipment

  • package

  • parcel_line_items

  • attachments

  • events

Last updated