Pickups

Carrier pickup scheduling

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List pickups

GET/api/v1/pickups

Responses

200 Pickup list

GET/api/v1/pickups

List pickups

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/pickups

Schedule a carrier pickup

POST/api/v1/pickups

Request body

Field	Type	Description
carrierAccountId	string
pickupDate	string
pickupAddress	Address
readyTime	string
closeTime	string
packageCount	integer
totalWeight	Weight

{
  "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "pickupDate": "2026-07-23T12:00:00Z",
  "pickupAddress": {
    "name": "Jane Doe",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "zip": "94107",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "email": "jane@example.com"
  },
  "readyTime": "2026-07-23T12:00:00Z",
  "closeTime": "2026-07-23T12:00:00Z",
  "packageCount": 0,
  "totalWeight": {
    "value": 0,
    "unit": "oz"
  }
}

Responses

201 Pickup scheduled

POST/api/v1/pickups

Schedule a carrier pickup

API key (Bearer token)

Request body (JSON){ "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000", "pickupDate": "2026-07-23T12:00:00Z", "pickupAddress": { "name": "Jane Doe", "company": "string", "address1": "string", "address2": "string", "city": "string", "province": "string", "provinceCode": "string", "zip": "94107", "country": "string", "countryCode": "string", "phone": "string", "email": "jane@example.com" }, "readyTime": "2026-07-23T12:00:00Z", "closeTime": "2026-07-23T12:00:00Z", "packageCount": 0, "totalWeight": { "value": 0, "unit": "oz" } }

https://api-test.orderly-hub.com/api/v1/pickups

Get pickup details

GET/api/v1/pickups/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Pickup details

GET/api/v1/pickups/{id}

Get pickup details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/pickups/

Cancel a pickup

DELETE/api/v1/pickups/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Pickup cancelled

DELETE/api/v1/pickups/{id}

Cancel a pickup

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/pickups/