v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB

package_pickups

Get Pickup By ID

get/v1/pickups/{pickup_id}

Response

The request was a success.

pickup_idstring required

Pickup Resource ID

label_idsSeId[] required

Label IDs that will be included in the pickup request

created_atstring date-time required

An ISO 8601 string that represents a date and time.

cancelled_atstring date-time

An ISO 8601 string that represents a date and time.

carrier_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

confirmation_numberstring nullable required

The carrier confirmation number for the scheduled pickup.

warehouse_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

pickup_notesstring

Used by some carriers to give special instructions for a package pickup

request_idstring uuid required

A UUID (a.k.a. GUID) that uniquely identifies a resource

Example response

{
  "pickup_id": "pik_3YcKU5zdtJuCqoeNwyqqbW",
  "label_ids": [
    "se-28529731"
  ],
  "created_at": "2018-09-23T15:00:00.000Z",
  "cancelled_at": "2018-09-23T15:00:00.000Z",
  "carrier_id": "se-28529731",
  "confirmation_number": "292513CL4A3",
  "warehouse_id": "se-28529731",
  "pickup_address": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA"
  },
  "contact_details": {
    "email": "john.doe@example.com"
  },
  "pickup_window": {
    "start_at": "2018-09-23T15:00:00.000Z",
    "end_at": "2018-09-23T15:00:00.000Z"
  },
  "pickup_windows": [
    {
      "start_at": "2018-09-23T15:00:00.000Z",
      "end_at": "2018-09-23T15:00:00.000Z"
    }
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}