Orders

Unified order 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 orders

GET/api/v1/orders

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
status	query	no	string
bridgeId	query	no	string
search	query	no	string	Search by order number or external ID
include	query	no	string	Comma-separated: bridge, dispatch_assignments

Responses

200 Paginated order list

Order[] object:

Field	Type	Description
id	string
organizationId	string
bridgeId	string
externalId	string
orderNumber	string
status	string
paymentStatus	string
fulfillmentStatus	string
customer	object
shippingAddress	Address
billingAddress	Address
lineItems	array
totals	object
currency	string
tags	array
note	string
metadata	object
sourceData	object
orderedAt	string
createdAt	string
updatedAt	string

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "550e8400-e29b-41d4-a716-446655440000",
      "orderNumber": "string",
      "status": "pending",
      "paymentStatus": "pending",
      "fulfillmentStatus": "pending",
      "customer": {},
      "shippingAddress": {
        "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"
      },
      "billingAddress": {
        "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"
      },
      "lineItems": [
        {}
      ],
      "totals": {},
      "currency": "USD",
      "tags": [
        "string"
      ],
      "note": "string",
      "metadata": {},
      "sourceData": {},
      "orderedAt": "2026-07-23T12:00:00Z",
      "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/orders

List orders

API key (Bearer token)

page (query)

limit (query)

status (query)

bridgeId (query)

search (query)

include (query)

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

Create an order

POST/api/v1/orders

Request body

Field	Type	Description
bridgeId	string
externalId	string
orderNumber	string
status	string
paymentStatus	string
fulfillmentStatus	string
customer	object
shippingAddress	Address
billingAddress	Address
lineItems	array
totals	object
currency	string
tags	array
note	string
metadata	object
sourceData	object
orderedAt	string

{
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "550e8400-e29b-41d4-a716-446655440000",
  "orderNumber": "string",
  "status": "pending",
  "paymentStatus": "pending",
  "fulfillmentStatus": "pending",
  "customer": {},
  "shippingAddress": {
    "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"
  },
  "billingAddress": {
    "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"
  },
  "lineItems": [
    {}
  ],
  "totals": {},
  "currency": "USD",
  "tags": [
    "string"
  ],
  "note": "string",
  "metadata": {},
  "sourceData": {},
  "orderedAt": "2026-07-23T12:00:00Z"
}

Responses

201 Order created

Order object:

Field	Type	Description
id	string
organizationId	string
bridgeId	string
externalId	string
orderNumber	string
status	string
paymentStatus	string
fulfillmentStatus	string
customer	object
shippingAddress	Address
billingAddress	Address
lineItems	array
totals	object
currency	string
tags	array
note	string
metadata	object
sourceData	object
orderedAt	string
createdAt	string
updatedAt	string

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "550e8400-e29b-41d4-a716-446655440000",
    "orderNumber": "string",
    "status": "pending",
    "paymentStatus": "pending",
    "fulfillmentStatus": "pending",
    "customer": {},
    "shippingAddress": {
      "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"
    },
    "billingAddress": {
      "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"
    },
    "lineItems": [
      {}
    ],
    "totals": {},
    "currency": "USD",
    "tags": [
      "string"
    ],
    "note": "string",
    "metadata": {},
    "sourceData": {},
    "orderedAt": "2026-07-23T12:00:00Z",
    "createdAt": "2026-07-23T12:00:00Z",
    "updatedAt": "2026-07-23T12:00:00Z"
  }
}

409 Duplicate external ID

POST/api/v1/orders

Create an order

API key (Bearer token)

Request body (JSON){ "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "externalId": "550e8400-e29b-41d4-a716-446655440000", "orderNumber": "string", "status": "pending", "paymentStatus": "pending", "fulfillmentStatus": "pending", "customer": {}, "shippingAddress": { "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" }, "billingAddress": { "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" }, "lineItems": [ {} ], "totals": {}, "currency": "USD", "tags": [ "string" ], "note": "string", "metadata": {}, "sourceData": {}, "orderedAt": "2026-07-23T12:00:00Z" }

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

Get single order

GET/api/v1/orders/{id}

Parameters

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

Responses

200 Order details

Order object:

Field	Type	Description
id	string
organizationId	string
bridgeId	string
externalId	string
orderNumber	string
status	string
paymentStatus	string
fulfillmentStatus	string
customer	object
shippingAddress	Address
billingAddress	Address
lineItems	array
totals	object
currency	string
tags	array
note	string
metadata	object
sourceData	object
orderedAt	string
createdAt	string
updatedAt	string

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "550e8400-e29b-41d4-a716-446655440000",
    "orderNumber": "string",
    "status": "pending",
    "paymentStatus": "pending",
    "fulfillmentStatus": "pending",
    "customer": {},
    "shippingAddress": {
      "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"
    },
    "billingAddress": {
      "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"
    },
    "lineItems": [
      {}
    ],
    "totals": {},
    "currency": "USD",
    "tags": [
      "string"
    ],
    "note": "string",
    "metadata": {},
    "sourceData": {},
    "orderedAt": "2026-07-23T12:00:00Z",
    "createdAt": "2026-07-23T12:00:00Z",
    "updatedAt": "2026-07-23T12:00:00Z"
  }
}

404 Order not found

GET/api/v1/orders/{id}

Get single order

API key (Bearer token)

id * (path)

include (query)

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

Update an order

PATCH/api/v1/orders/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
status	string
paymentStatus	string
fulfillmentStatus	string
tags	array
note	string
metadata	object

{
  "status": "pending",
  "paymentStatus": "pending",
  "fulfillmentStatus": "pending",
  "tags": [
    "string"
  ],
  "note": "string",
  "metadata": {}
}

Responses

200 Order updated

404 Order not found

PATCH/api/v1/orders/{id}

Update an order

API key (Bearer token)

id * (path)

Request body (JSON){ "status": "pending", "paymentStatus": "pending", "fulfillmentStatus": "pending", "tags": [ "string" ], "note": "string", "metadata": {} }

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

Delete an order

DELETE/api/v1/orders/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Order deleted

DELETE/api/v1/orders/{id}

Delete an order

API key (Bearer token)

id * (path)

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

Get order activity feed

GET/api/v1/orders/{id}/activities

Parameters

Name	In	Required	Type	Description
id	path	yes	string
limit	query	no	integer
offset	query	no	integer

Responses

200 Activity list

404 Order not found

GET/api/v1/orders/{id}/activities

Get order activity feed

API key (Bearer token)

id * (path)

limit (query)

offset (query)

https://api-test.orderly-hub.com/api/v1/orders//activities

Add a note to an order

POST/api/v1/orders/{id}/notes

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
note	string

{
  "note": "string"
}

Responses

201 Note added

POST/api/v1/orders/{id}/notes

Add a note to an order

API key (Bearer token)

id * (path)

Request body (JSON){ "note": "string" }

https://api-test.orderly-hub.com/api/v1/orders//notes