GET
Retrieve a Pickup

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Path Parameters

id
string
required

Query Parameters

expand[]
string[]

Response

OK

id
string
required

Prefixed pck_

Example:

"pck_1Q2w3E4r"

object
enum<string>
required
Available options:
pickup
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

status
enum<string>
required
Available options:
scheduled,
rescheduled,
completed,
missed,
cancelled,
failed
connection
string
required
date
string<date>
required
window
object
required
updated
integer<unix-time>

Unix timestamp (seconds)

carrier
string
confirmation_number
string | null
contact
object

A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.

timezone
string
location
enum<string>
Available options:
front_door,
back_door,
side_door,
front_desk,
reception,
mailroom,
loading_dock,
garage,
other
instructions
string
shipments
string[]
manifest

ID (mfst_...). Expandable to Manifest.

handling_unit_count
integer
total_weight
object
type
enum<string>
Available options:
one_time,
scheduled
schedule

ID (psch_...). Expandable to PickupSchedule.

amount
object | null
documents
object[]
cancellation
object | null
messages
object[]
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.