latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

package_pickups

Get pickup by id

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Get Pickup By ID

get/v2/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 ShipStation resource, such as a carrier, label, shipment, etc.

confirmation_numberstring required

The carrier confirmation number for the scheduled pickup.

warehouse_idstring required

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

pickup_notesstring required

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": {
    "name": "Jonh",
    "email": "john.doe@example.com",
    "phone": "89876752562"
  },
  "pickup_notes": "call before 15:00",
  "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.",
      "field_name": "inventory_warehouse_id",
      "field_value": "invalid-id"
    }
  ]
}