List all easypost pickups

How to fetch a collection of easypost pickups via API

To fetch a collection of easypost pickups, send a GET request to the /api/easypost_pickups endpoint.

Request

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

Example

Request

The following request fetches a collection of easypost pickups:

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

Response

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

Sortable fields

The list of easypost pickups can be sorted by the following fields:

Attributes

• type

• status

• id

• created_at

• updated_at

• reference

• reference_origin

• min_datetime

• max_datetime

• purchase_started_at

• purchase_completed_at

Relationships

• shipment

Filterable fields

The list of easypost pickups can be filtered by the following fields:

Attributes

• type

• status

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

• min_datetime

• max_datetime

• purchase_started_at

• purchase_completed_at

Relationships

• shipment

• parcels

• events