List all pickups

How to fetch a collection of pickups via API

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

Request

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

Example

The following request fetches a collection of pickups:

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

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "XAyRWNUzyN",
      "type": "pickups",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN"
      },
      "attributes": {
        "type": "easypost_pickups",
        "status": "unknown",
        "internal_id": "pickup_13e5d7e2a7824432a07975bc553944bc",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "shipment": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/relationships/shipment",
            "related": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/shipment"
          }
        },
        "parcels": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/relationships/parcels",
            "related": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/parcels"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/events"
          }
        },
        "event_stores": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/relationships/event_stores",
            "related": "https://yourdomain.commercelayer.io/api/pickups/XAyRWNUzyN/event_stores"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 pickups (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/pickups?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/pickups?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/pickups?page[number]=14&page[size]=10"
  }
}

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

Sortable fields

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

Attributes

type
status
id
created_at
updated_at
reference
reference_origin

Relationships

shipment

Filterable fields

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

Attributes

type
status
id
created_at
updated_at
reference
reference_origin
metadata

Relationships

shipment
parcels
events

PreviousThe pickup object NextRetrieve a pickup

Last updated 5 months ago

hashtagRequest

hashtagExample

hashtagSortable fields

hashtagAttributes

hashtagRelationships

hashtagFilterable fields

hashtagAttributes

hashtagRelationships

Request

Example

Sortable fields

Attributes

Relationships

Filterable fields

Attributes

Relationships