Hub Gateway API

Cancel Order

Cancel a distributor's cloud order and release its inventory holds.

DELETE /api/hub/orders/:reference

Use Case

Cancel a distributor's cloud order and release its inventory holds. Each sub-order still cancellable per the state machine transitions to cancelled, its reservations are released (freeing stock), and any issued-but-unpaid invoice is voided (a paid invoice is left intact). Scoped to the calling distributor (404 if not owned). Response sets cache-control: no-store.

Idempotent — an already-cancelled order returns 200. If nothing is cancellable because the order is too far along (shipped / delivered / completed), the current status is returned with 409.

Header Parameters

Parameter	Data Type	Required	Description
`x-hub-api-key`	string	true	Shared Hub service key.

Path Parameters

Parameter	Data Type	Required	Description
`reference`	string	true	The order reference used at creation.

Query Parameters

Parameter	Data Type	Required	Description
`hubCustomerId`	string	true	The owning distributor's Hub customer id.

Example Request

curl -X DELETE \
  "https://<your-b2b-host>/api/hub/orders/hub-order-9f2a?hubCustomerId=hub_cust_1" \
  -H "x-hub-api-key: $HUB_API_KEY"

Response Parameters

Parameter	Data Type	Description
`reference`	string	Echoed reference.
`status`	string	`cancelled`, or the current status if not cancellable.
`cancelled`	boolean	Whether the order is now cancelled.

Example Response

{ "reference": "hub-order-9f2a", "status": "cancelled", "cancelled": true }

Error Responses

Status	Body	When
`200`	`{ "reference": "…", "status": "cancelled", "cancelled": true }`	Cancelled, or already cancelled (idempotent).
`409`	`{ "reference": "…", "status": "<current>", "cancelled": false }`	Too far along (shipped / delivered / completed).
`400`	`{ "error": "hubCustomerId is required" }`	Missing query param.
`404`	`{ "error": "Not found" }`	Unknown reference, or not owned by the caller.
`401`	`{ "error": "Unauthorized" }`	Bad or missing API key.
`500`	`{ "error": "Failed to cancel order" }`	Unhandled server error.

Get Order

Status, invoice, and line items for a distributor's cloud order.

Cancel Order

Cancel a distributor's cloud order and release its inventory holds.

DELETE /api/hub/orders/:reference

Use Case

Idempotent — an already-cancelled order returns 200. If nothing is cancellable because the order is too far along (shipped / delivered / completed), the current status is returned with 409.

Header Parameters

Parameter	Data Type	Required	Description
`x-hub-api-key`	string	true	Shared Hub service key.

Path Parameters

Parameter	Data Type	Required	Description
`reference`	string	true	The order reference used at creation.

Query Parameters

Parameter	Data Type	Required	Description
`hubCustomerId`	string	true	The owning distributor's Hub customer id.

Example Request

curl -X DELETE \
  "https://<your-b2b-host>/api/hub/orders/hub-order-9f2a?hubCustomerId=hub_cust_1" \
  -H "x-hub-api-key: $HUB_API_KEY"

Response Parameters

Parameter	Data Type	Description
`reference`	string	Echoed reference.
`status`	string	`cancelled`, or the current status if not cancellable.
`cancelled`	boolean	Whether the order is now cancelled.

Example Response

{ "reference": "hub-order-9f2a", "status": "cancelled", "cancelled": true }

Error Responses

Status	Body	When
`200`	`{ "reference": "…", "status": "cancelled", "cancelled": true }`	Cancelled, or already cancelled (idempotent).
`409`	`{ "reference": "…", "status": "<current>", "cancelled": false }`	Too far along (shipped / delivered / completed).
`400`	`{ "error": "hubCustomerId is required" }`	Missing query param.
`404`	`{ "error": "Not found" }`	Unknown reference, or not owned by the caller.
`401`	`{ "error": "Unauthorized" }`	Bad or missing API key.
`500`	`{ "error": "Failed to cancel order" }`	Unhandled server error.

Get Order

Status, invoice, and line items for a distributor's cloud order.

Cancel Order

Use Case

Header Parameters

Path Parameters

Query Parameters

Example Request

Response Parameters

Example Response

Error Responses

目录

Cancel Order

Use Case

Header Parameters

Path Parameters

Query Parameters

Example Request

Response Parameters

Example Response

Error Responses

目录