package_pickups

List Scheduled Pickups

Changed on Oct 8, 2024

List all pickups that have been scheduled for this carrier

get/v1/pickups

Request

Base URL
https://api.shipengine.com
URL
https://api.shipengine.com/v1/pickups
Auth
API key in header API-Key

Query parameters

carrier_idstring

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

Example:se-28529731

Carrier ID

warehouse_idstring

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

Example:se-28529731

Warehouse ID

created_at_startstring date-time

Only return scheduled pickups that were created on or after a specific date/time

created_at_endstring date-time

Only return scheduled pickups that were created on or before a specific date/time

pageinteger

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

page_sizeinteger

The number of results to return per response.

Response

The request was a success.

totalinteger required

The total number of pickups returned

pageinteger required

Current page of the list pickups results

pagesinteger required

Total number of pages for list pickups results

request_idstring uuid required

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

Example response

{
  "pickups": [
    {
      "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"
        }
      ]
    }
  ],
  "total": 3,
  "page": 3,
  "pages": 4,
  "links": {
    "first": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    },
    "last": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    },
    "prev": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    },
    "next": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    }
  },
  "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"
    }
  ]
}

Changes

Oct 8, 2024e4ae9b442f54 Revision changes
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
Sep 13, 20245a15ef11fd60 Revision changes
- warning
  added the new file_not_found enum value to the ///// response property for the response status
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the ///// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the ///// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the ///// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the ///// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the ///// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the ///// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status

Operation history (3 revisions)