package_pickups

Schedule a pickup

Changed on Oct 22, 2026

Schedule a package pickup with a carrier

post/v1/pickups

Request

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

Request body

pickup_idstring

Pickup Resource ID

label_idsSeId[]

Label IDs that will be included in the pickup request

created_atstring date-time

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

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

confirmation_numberstring nullable

The carrier confirmation number for the scheduled pickup.

warehouse_idstring

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

Example request

{
  "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",
    "address_residential_indicator": "no"
  },
  "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"
    }
  ]
}

Response

The request was a success.

pickup_idstring

Pickup Resource ID

label_idsSeId[]

Label IDs that will be included in the pickup request

created_atstring date-time

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

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

confirmation_numberstring nullable

The carrier confirmation number for the scheduled pickup.

warehouse_idstring

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",
    "address_residential_indicator": "no"
  },
  "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": [
    {
      "error_source": "shipengine",
      "error_type": "validation",
      "error_code": "invalid_field_value",
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}

Changes

Oct 22, 2026e998dffc42be Revision changes
- warning
  added the new bring_your_own_label_not_supported enum value to the /// response property for the response status
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the /// response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the /// response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
Oct 9, 2026020f57d6f5b8 Revision changes
- breaking
  the // request property's minLength was increased from 0 to 1
- breaking
  the //// request property's minLength was increased from 0 to 1
- breaking
  added the pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[-+]\d{2}:\d{2})$ to the request property //
- breaking
  added the pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[-+]\d{2}:\d{2})$ to the request property //
- breaking
  the // request property type changed from no type to string, and format from no format to email
- breaking
  the //// request property type changed from no type to string
- breaking
  the // request property type changed from no type to string, and format from no format to date-time
- breaking
  the // request property type changed from no type to string, and format from no format to date-time
- breaking
  the // request property type changed from no type to object
- breaking
  the // response's property type changed from no type to string, and format from no format to email for status
- breaking
  the //// response's property type changed from no type to string for status
- breaking
  the // response's property type changed from no type to string, and format from no format to date-time for status
- breaking
  the // response's property type changed from no type to string, and format from no format to date-time for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- warning
  removed from the // request property allOf list
- warning
  removed from the // request property allOf list
- warning
  removed from the // request property allOf list
- warning
  removed from the // request property allOf list
- warning
  removed from the //// request property allOf list
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- 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
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  removed from the // response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  removed from the //// response property allOf list for the response status
- info
  the // response's property pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[-+]\d{2}:\d{2})$ was added for the status
- info
  the // response's property pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[-+]\d{2}:\d{2})$ was added for the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history (4 revisions)