Shipments

Unified shipment management

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 shipments

GET/api/v1/shipments

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
status	query	no	string
bridgeId	query	no	string
orderId	query	no	string
trackingNumber	query	no	string
include	query	no	string	Comma-separated: bridge, order

Responses

200 Paginated shipment list

Shipment[] object:

Field	Type	Description
id	string
organizationId	string
bridgeId	string
orderId	string
externalId	string
trackingNumber	string
carrier	string
carrierCode	string
service	string
serviceCode	string
status	string
shipFrom	Address
shipTo	Address
items	array
shipDate	string
estimatedDelivery	string
actualDelivery	string
weight	Weight
dimensions	Dimensions
labelUrl	string
labelFormat	string
trackingUrl	string
trackingEvents	array
metadata	object
sourceData	object
createdAt	string
updatedAt	string

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
      "orderId": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "550e8400-e29b-41d4-a716-446655440000",
      "trackingNumber": "string",
      "carrier": "string",
      "carrierCode": "string",
      "service": "string",
      "serviceCode": "string",
      "status": "pending",
      "shipFrom": {
        "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"
      },
      "shipTo": {
        "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"
      },
      "items": [
        {}
      ],
      "shipDate": "2026-07-23T12:00:00Z",
      "estimatedDelivery": "string",
      "actualDelivery": "string",
      "weight": {
        "value": 0,
        "unit": "oz"
      },
      "dimensions": {
        "length": 0,
        "width": 0,
        "height": 0,
        "unit": "in"
      },
      "labelUrl": "string",
      "labelFormat": "2026-07-23T12:00:00Z",
      "trackingUrl": "string",
      "trackingEvents": [
        {}
      ],
      "metadata": {},
      "sourceData": {},
      "createdAt": "2026-07-23T12:00:00Z",
      "updatedAt": "2026-07-23T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 49.99,
    "totalPages": 0,
    "hasMore": true
  }
}

GET/api/v1/shipments

List shipments

API key (Bearer token)

page (query)

limit (query)

status (query)

bridgeId (query)

orderId (query)

trackingNumber (query)

include (query)

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

Create a shipment

POST/api/v1/shipments

Request body

Field	Type	Description
bridgeId	string
orderId	string
externalId	string
trackingNumber	string
carrier	string
carrierCode	string
service	string
serviceCode	string
status	string
shipFrom	Address
shipTo	Address
items	array
shipDate	string
estimatedDelivery	string
weight	Weight
dimensions	Dimensions
labelUrl	string
labelFormat	string
metadata	object
sourceData	object

{
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "orderId": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "550e8400-e29b-41d4-a716-446655440000",
  "trackingNumber": "string",
  "carrier": "string",
  "carrierCode": "string",
  "service": "string",
  "serviceCode": "string",
  "status": "pending",
  "shipFrom": {
    "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"
  },
  "shipTo": {
    "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"
  },
  "items": [
    {}
  ],
  "shipDate": "2026-07-23T12:00:00Z",
  "estimatedDelivery": "string",
  "weight": {
    "value": 0,
    "unit": "oz"
  },
  "dimensions": {
    "length": 0,
    "width": 0,
    "height": 0,
    "unit": "in"
  },
  "labelUrl": "string",
  "labelFormat": "2026-07-23T12:00:00Z",
  "metadata": {},
  "sourceData": {}
}

Responses

201 Shipment created

POST/api/v1/shipments

Create a shipment

API key (Bearer token)

Request body (JSON){ "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "orderId": "550e8400-e29b-41d4-a716-446655440000", "externalId": "550e8400-e29b-41d4-a716-446655440000", "trackingNumber": "string", "carrier": "string", "carrierCode": "string", "service": "string", "serviceCode": "string", "status": "pending", "shipFrom": { "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" }, "shipTo": { "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" }, "items": [ {} ], "shipDate": "2026-07-23T12:00:00Z", "estimatedDelivery": "string", "weight": { "value": 0, "unit": "oz" }, "dimensions": { "length": 0, "width": 0, "height": 0, "unit": "in" }, "labelUrl": "string", "labelFormat": "2026-07-23T12:00:00Z", "metadata": {}, "sourceData": {} }

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

Get single shipment

GET/api/v1/shipments/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string
include	query	no	string	Comma-separated: bridge, order

Responses

200 Shipment details

404 Shipment not found

GET/api/v1/shipments/{id}

Get single shipment

API key (Bearer token)

id * (path)

include (query)

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

Update a shipment

PATCH/api/v1/shipments/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
trackingNumber	string
status	string
shipDate	string
estimatedDelivery	string
actualDelivery	string
trackingEvents	array
metadata	object

{
  "trackingNumber": "string",
  "status": "pending",
  "shipDate": "2026-07-23T12:00:00Z",
  "estimatedDelivery": "string",
  "actualDelivery": "string",
  "trackingEvents": [
    {}
  ],
  "metadata": {}
}

Responses

200 Shipment updated

404 Shipment not found

PATCH/api/v1/shipments/{id}

Update a shipment

API key (Bearer token)

id * (path)

Request body (JSON){ "trackingNumber": "string", "status": "pending", "shipDate": "2026-07-23T12:00:00Z", "estimatedDelivery": "string", "actualDelivery": "string", "trackingEvents": [ {} ], "metadata": {} }

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

Delete a shipment

DELETE/api/v1/shipments/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Shipment deleted

DELETE/api/v1/shipments/{id}

Delete a shipment

API key (Bearer token)

id * (path)

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

Execute a shipment action (hold, redirect, etc.)

POST/api/v1/shipments/{id}/actions

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
actionType	hold | redirect | redeliver | delivery_instructions
config	object

{
  "actionType": "hold",
  "config": {}
}

Responses

200 Action created

Response fields:

Field	Type	Description
actionId	string
status	string

{
  "actionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending"
}

POST/api/v1/shipments/{id}/actions

Execute a shipment action (hold, redirect, etc.)

API key (Bearer token)

id * (path)

Request body (JSON){ "actionType": "hold", "config": {} }

https://api-test.orderly-hub.com/api/v1/shipments//actions