Retrieve a pickup

How to fetch a specific pickup via API

To fetch a single pickup, send a GET request to the /api/pickups/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

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

Example

Request

The following request fetches the pickup identified by the id "xYZkjABcde":

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

Response

On success, the API responds with a 200 OK status code, returning a single resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "pickups",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/pickups/xYZkjABcde"
    },
    "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/xYZkjABcde/relationships/shipment",
          "related": "https://yourdomain.commercelayer.io/api/pickups/xYZkjABcde/shipment"
        }
      },
      "parcels": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/pickups/xYZkjABcde/relationships/parcels",
          "related": "https://yourdomain.commercelayer.io/api/pickups/xYZkjABcde/parcels"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/pickups/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/pickups/xYZkjABcde/events"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}