Releases

Endpoints for releases.

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 order releases for the organization

GET/api/v1/releases

Parameters

Name	In	Required	Type	Description
order_id	query	no	string
status	query	no	pending | queued | processing | accepted | ineligible | rejected | failed | cancelled

Responses

200 Up to 200 most recent releases, newest first

"string"

400 Invalid query parameters

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

GET/api/v1/releases

List order releases for the organization

API key (Bearer token)

order_id (query)

status (query)

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

Release a single order to its destination (WMS or Dispatch Lane)

POST/api/v1/releases

Request body

Field	Type	Description
order_id	string
destination	BRIDGE_WMS | DISPATCH_LANE	Override the policy-derived destination
bridge_id	string
fulfillment_location_id	string
lines	array	Partial release lines; omit for a full release
packages	array
acknowledged_warnings	array	Warning codes the caller has explicitly acknowledged

{
  "order_id": "550e8400-e29b-41d4-a716-446655440000",
  "destination": "BRIDGE_WMS",
  "bridge_id": "550e8400-e29b-41d4-a716-446655440000",
  "fulfillment_location_id": "550e8400-e29b-41d4-a716-446655440000",
  "lines": [
    {
      "order_line_id": "550e8400-e29b-41d4-a716-446655440000",
      "external_line_id": "550e8400-e29b-41d4-a716-446655440000",
      "sku": "string",
      "released_quantity": 0,
      "substitution_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "packages": [
    {
      "index": 0,
      "weightOz": 0,
      "lengthIn": 0,
      "widthIn": 0,
      "heightIn": 0,
      "packagingType": "string",
      "items": [
        {
          "sku": null,
          "quantity": null
        }
      ]
    }
  ],
  "acknowledged_warnings": [
    "string"
  ]
}

Responses

200 Release created

Response fields:

Field	Type	Description
order_id	string
release_id	string
status	string
destination	BRIDGE_WMS | DISPATCH_LANE
ok	boolean
dispatch_lane_link	string

{
  "data": {
    "order_id": "550e8400-e29b-41d4-a716-446655440000",
    "release_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "pending",
    "destination": "BRIDGE_WMS",
    "ok": true,
    "dispatch_lane_link": "string"
  }
}

400 Invalid request body

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Order not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

422 Order is not releasable (blocking codes or unacknowledged warnings)

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "RELEASE_BLOCKED",
    "message": "string",
    "details": {
      "order_id": "550e8400-e29b-41d4-a716-446655440000",
      "ok": true,
      "blocking": [
        "string"
      ],
      "unacknowledged_warnings": [
        "string"
      ],
      "error": "string"
    }
  }
}

POST/api/v1/releases

Release a single order to its destination (WMS or Dispatch Lane)

API key (Bearer token)

Request body (JSON){ "order_id": "550e8400-e29b-41d4-a716-446655440000", "destination": "BRIDGE_WMS", "bridge_id": "550e8400-e29b-41d4-a716-446655440000", "fulfillment_location_id": "550e8400-e29b-41d4-a716-446655440000", "lines": [ { "order_line_id": "550e8400-e29b-41d4-a716-446655440000", "external_line_id": "550e8400-e29b-41d4-a716-446655440000", "sku": "string", "released_quantity": 0, "substitution_id": "550e8400-e29b-41d4-a716-446655440000" } ], "packages": [ { "index": 0, "weightOz": 0, "lengthIn": 0, "widthIn": 0, "heightIn": 0, "packagingType": "string", "items": [ { "sku": null, "quantity": null } ] } ], "acknowledged_warnings": [ "string" ] }

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

Release multiple orders in one request, optionally atomically

POST/api/v1/releases/bulk

Request body

Field	Type	Description
orders	array
atomic	boolean	Reject the whole batch if any order is ineligible

{
  "orders": [
    {
      "order_id": "550e8400-e29b-41d4-a716-446655440000",
      "destination": "BRIDGE_WMS",
      "bridge_id": "550e8400-e29b-41d4-a716-446655440000",
      "fulfillment_location_id": "550e8400-e29b-41d4-a716-446655440000",
      "lines": [
        {
          "order_line_id": null,
          "external_line_id": null,
          "sku": null,
          "released_quantity": null,
          "substitution_id": null
        }
      ],
      "packages": [
        {
          "index": null,
          "weightOz": null,
          "items": null
        }
      ],
      "acknowledged_warnings": [
        "string"
      ]
    }
  ],
  "atomic": true
}

Responses

200 Bulk release outcome

Response fields:

Field	Type	Description
released	integer
failed	integer
results	array

{
  "data": {
    "released": 0,
    "failed": 0,
    "results": [
      {
        "order_id": "550e8400-e29b-41d4-a716-446655440000",
        "release_id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "pending",
        "destination": "BRIDGE_WMS",
        "ok": true,
        "blocking": [],
        "unacknowledged_warnings": [],
        "error": "string",
        "dispatch_lane_link": "string"
      }
    ]
  }
}

400 Invalid request body

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

422 Atomic batch refused, one or more orders ineligible

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/bulk

Release multiple orders in one request, optionally atomically

API key (Bearer token)

Request body (JSON){ "orders": [ { "order_id": "550e8400-e29b-41d4-a716-446655440000", "destination": "BRIDGE_WMS", "bridge_id": "550e8400-e29b-41d4-a716-446655440000", "fulfillment_location_id": "550e8400-e29b-41d4-a716-446655440000", "lines": [ { "order_line_id": null, "external_line_id": null, "sku": null, "released_quantity": null, "substitution_id": null } ], "packages": [ { "index": null, "weightOz": null, "items": null } ], "acknowledged_warnings": [ "string" ] } ], "atomic": true }

https://api-test.orderly-hub.com/api/v1/releases/bulk

Evaluate release eligibility for a batch of orders

POST/api/v1/releases/eligibility

Request body

Field	Type	Description
order_ids	array

{
  "order_ids": [
    "string"
  ]
}

Responses

200 Eligibility results, one per requested order

Response fields:

Field	Type	Description
orderId	string
eligible	boolean
destination	BRIDGE_WMS | DISPATCH_LANE
bridgeId	string
fulfillmentLocationId	string
ownership	object
blocking	array	Blocking eligibility codes; empty when eligible
warnings	array	Warning codes requiring acknowledgement before release
proposedLines	array
requestedShipDate	string
policyVersion	integer
dispatchAssignmentId	string

{
  "data": [
    {
      "orderId": "550e8400-e29b-41d4-a716-446655440000",
      "eligible": true,
      "destination": "BRIDGE_WMS",
      "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
      "fulfillmentLocationId": "550e8400-e29b-41d4-a716-446655440000",
      "ownership": {
        "packing": "WMS",
        "substitution": "WMS",
        "label": "WMS"
      },
      "blocking": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "proposedLines": [
        {
          "sku": null,
          "orderedQuantity": null,
          "releasedQuantity": null
        }
      ],
      "requestedShipDate": "2026-07-23T12:00:00Z",
      "policyVersion": 0,
      "dispatchAssignmentId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

400 Invalid request body

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/eligibility

Evaluate release eligibility for a batch of orders

API key (Bearer token)

Request body (JSON){ "order_ids": [ "string" ] }

https://api-test.orderly-hub.com/api/v1/releases/eligibility

Evaluate release eligibility for a single order

POST/api/v1/releases/orders/{orderId}/eligibility

Parameters

Name	In	Required	Type	Description
orderId	path	yes	string

Responses

200 Eligibility result for the order

Response fields:

Field	Type	Description
orderId	string
eligible	boolean
destination	BRIDGE_WMS | DISPATCH_LANE
bridgeId	string
fulfillmentLocationId	string
ownership	object
blocking	array
warnings	array
proposedLines	array
requestedShipDate	string
policyVersion	integer
dispatchAssignmentId	string

{
  "data": {
    "orderId": "550e8400-e29b-41d4-a716-446655440000",
    "eligible": true,
    "destination": "BRIDGE_WMS",
    "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
    "fulfillmentLocationId": "550e8400-e29b-41d4-a716-446655440000",
    "ownership": {
      "packing": "WMS",
      "substitution": "WMS",
      "label": "WMS"
    },
    "blocking": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "proposedLines": [
      {
        "sku": "string",
        "orderedQuantity": 0,
        "releasedQuantity": 0
      }
    ],
    "requestedShipDate": "2026-07-23T12:00:00Z",
    "policyVersion": 0,
    "dispatchAssignmentId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

400 Invalid request

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Order not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/orders/{orderId}/eligibility

Evaluate release eligibility for a single order

API key (Bearer token)

orderId * (path)

Request body (JSON)

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

List SKU substitutions recorded for an order

GET/api/v1/releases/orders/{orderId}/substitutions

Parameters

Name	In	Required	Type	Description
orderId	path	yes	string

Responses

200 Substitutions for the order, newest first

Response fields:

Field	Type	Description
id	string
organization_id	string
order_id	string
order_line_id	string
original_sku	string
original_product_ref	string
replacement_sku	string
replacement_product_ref	string
requested_quantity	integer
substituted_quantity	integer
remaining_quantity	integer
reason	string
source	user | rule | import | wms
status	proposed | approved | rejected | applied
proposed_by	string
approved_by	string
metadata	object
created_at	string
updated_at	string

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "order_id": "550e8400-e29b-41d4-a716-446655440000",
      "order_line_id": "550e8400-e29b-41d4-a716-446655440000",
      "original_sku": "string",
      "original_product_ref": "string",
      "replacement_sku": "string",
      "replacement_product_ref": "string",
      "requested_quantity": 0,
      "substituted_quantity": 0,
      "remaining_quantity": 0,
      "reason": "string",
      "source": "user",
      "status": "proposed",
      "proposed_by": "string",
      "approved_by": "string",
      "metadata": {},
      "created_at": "2026-07-23T12:00:00Z",
      "updated_at": "2026-07-23T12:00:00Z"
    }
  ]
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

GET/api/v1/releases/orders/{orderId}/substitutions

List SKU substitutions recorded for an order

API key (Bearer token)

orderId * (path)

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

Pull a released order back to awaiting release

POST/api/v1/releases/orders/{orderId}/unrelease

Reverses a Dispatch Lane release while no shipping label is active. Cancels the assigned rate/service, frees inventory reservations, cancels the release record, and returns the order's operational lifecycle to awaiting_release so it can be re-released later.

Parameters

Name	In	Required	Type	Description
orderId	path	yes	string

Responses

200 Order returned to awaiting release

Response fields:

Field	Type	Description
order_id	string
release_id	string
lifecycle_state	string
assignments_cancelled	integer
reservations_released	integer

{
  "data": {
    "order_id": "550e8400-e29b-41d4-a716-446655440000",
    "release_id": "550e8400-e29b-41d4-a716-446655440000",
    "lifecycle_state": "awaiting_release",
    "assignments_cancelled": 0,
    "reservations_released": 0
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Order not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

409 Order is not in an un-releasable state or has an active label

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/orders/{orderId}/unrelease

Pull a released order back to awaiting release

API key (Bearer token)

orderId * (path)

Request body (JSON)

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

Get the organization's order release policy settings

GET/api/v1/releases/settings/policy

Responses

200 Current release settings

Response fields:

Field	Type	Description
policyVersion	integer
routing	object
timing	object
shipDate	object
ownership	object
partial	object
substitutionPolicy	NOT_ALLOWED | REQUIRE_APPROVAL | ALLOW_PREAPPROVED_MAPPING
inventoryPolicy	ignore | flag | force

{
  "data": {
    "policyVersion": 0,
    "routing": {
      "defaultFulfillmentLocationId": "550e8400-e29b-41d4-a716-446655440000",
      "allowManualDestinationOverride": true
    },
    "timing": {
      "mode": "manual",
      "releaseHorizonDays": 0,
      "timezone": "string",
      "dailyCutoff": "string",
      "releaseAtLocalTime": "2026-07-23T12:00:00Z",
      "businessDayMode": "calendar",
      "excludedWeekdays": [
        0
      ],
      "holidays": [
        "string"
      ],
      "noShipDatePolicy": "manual_review",
      "pastShipDatePolicy": "release"
    },
    "shipDate": {
      "source": "order_field",
      "tagPrefix": "string",
      "metadataField": "string",
      "leadTimeDays": 0,
      "leadTimeMode": "calendar"
    },
    "ownership": {
      "packing": "WMS",
      "substitution": "WMS",
      "label": "WMS"
    },
    "partial": {
      "policy": "require_full",
      "keepUnreleasedOpen": true,
      "maxActiveReleasesPerOrder": 0
    },
    "substitutionPolicy": "NOT_ALLOWED",
    "inventoryPolicy": "ignore"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

GET/api/v1/releases/settings/policy

Get the organization's order release policy settings

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/releases/settings/policy

Update the organization's order release policy settings

PUT/api/v1/releases/settings/policy

Request body

Field	Type	Description
routing	object
timing	object
shipDate	object
ownership	object
partial	object
substitutionPolicy	NOT_ALLOWED | REQUIRE_APPROVAL | ALLOW_PREAPPROVED_MAPPING
inventoryPolicy	ignore | flag | force

{
  "routing": {
    "defaultFulfillmentLocationId": "550e8400-e29b-41d4-a716-446655440000",
    "allowManualDestinationOverride": true
  },
  "timing": {
    "mode": "manual",
    "releaseHorizonDays": 0,
    "timezone": "string",
    "dailyCutoff": "string",
    "releaseAtLocalTime": "2026-07-23T12:00:00Z",
    "businessDayMode": "calendar",
    "excludedWeekdays": [
      0
    ],
    "holidays": [
      "string"
    ],
    "noShipDatePolicy": "manual_review",
    "pastShipDatePolicy": "release"
  },
  "shipDate": {
    "source": "order_field",
    "tagPrefix": "string",
    "metadataField": "string",
    "leadTimeDays": 0,
    "leadTimeMode": "calendar"
  },
  "ownership": {
    "packing": "WMS",
    "substitution": "WMS",
    "label": "WMS"
  },
  "partial": {
    "policy": "require_full",
    "keepUnreleasedOpen": true,
    "maxActiveReleasesPerOrder": 0
  },
  "substitutionPolicy": "NOT_ALLOWED",
  "inventoryPolicy": "ignore"
}

Responses

200 Updated release settings (policyVersion incremented)

Response fields:

Field	Type	Description
policyVersion	integer
routing	object
timing	object
shipDate	object
ownership	object
partial	object
substitutionPolicy	NOT_ALLOWED | REQUIRE_APPROVAL | ALLOW_PREAPPROVED_MAPPING
inventoryPolicy	ignore | flag | force

{
  "data": {
    "policyVersion": 0,
    "routing": {
      "defaultFulfillmentLocationId": "550e8400-e29b-41d4-a716-446655440000",
      "allowManualDestinationOverride": true
    },
    "timing": {
      "mode": "manual",
      "releaseHorizonDays": 0,
      "timezone": "string",
      "dailyCutoff": "string",
      "releaseAtLocalTime": "2026-07-23T12:00:00Z",
      "businessDayMode": "calendar",
      "excludedWeekdays": [
        0
      ],
      "holidays": [
        "string"
      ],
      "noShipDatePolicy": "manual_review",
      "pastShipDatePolicy": "release"
    },
    "shipDate": {
      "source": "order_field",
      "tagPrefix": "string",
      "metadataField": "string",
      "leadTimeDays": 0,
      "leadTimeMode": "calendar"
    },
    "ownership": {
      "packing": "WMS",
      "substitution": "WMS",
      "label": "WMS"
    },
    "partial": {
      "policy": "require_full",
      "keepUnreleasedOpen": true,
      "maxActiveReleasesPerOrder": 0
    },
    "substitutionPolicy": "NOT_ALLOWED",
    "inventoryPolicy": "ignore"
  }
}

400 Invalid request body

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

422 Invalid fulfillment-ownership combination

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

PUT/api/v1/releases/settings/policy

Update the organization's order release policy settings

API key (Bearer token)

Request body (JSON){ "routing": { "defaultFulfillmentLocationId": "550e8400-e29b-41d4-a716-446655440000", "allowManualDestinationOverride": true }, "timing": { "mode": "manual", "releaseHorizonDays": 0, "timezone": "string", "dailyCutoff": "string", "releaseAtLocalTime": "2026-07-23T12:00:00Z", "businessDayMode": "calendar", "excludedWeekdays": [ 0 ], "holidays": [ "string" ], "noShipDatePolicy": "manual_review", "pastShipDatePolicy": "release" }, "shipDate": { "source": "order_field", "tagPrefix": "string", "metadataField": "string", "leadTimeDays": 0, "leadTimeMode": "calendar" }, "ownership": { "packing": "WMS", "substitution": "WMS", "label": "WMS" }, "partial": { "policy": "require_full", "keepUnreleasedOpen": true, "maxActiveReleasesPerOrder": 0 }, "substitutionPolicy": "NOT_ALLOWED", "inventoryPolicy": "ignore" }

https://api-test.orderly-hub.com/api/v1/releases/settings/policy

Propose a SKU substitution for an order line

POST/api/v1/releases/substitutions

Request body

Field	Type	Description
order_id	string
order_line_id	string
original_sku	string
replacement_sku	string
requested_quantity	integer
substituted_quantity	integer
reason	string

{
  "order_id": "550e8400-e29b-41d4-a716-446655440000",
  "order_line_id": "550e8400-e29b-41d4-a716-446655440000",
  "original_sku": "string",
  "replacement_sku": "string",
  "requested_quantity": 0,
  "substituted_quantity": 0,
  "reason": "string"
}

Responses

200 Substitution recorded (status depends on org substitution policy)

Response fields:

Field	Type	Description
id	string
organization_id	string
order_id	string
order_line_id	string
original_sku	string
original_product_ref	string
replacement_sku	string
replacement_product_ref	string
requested_quantity	integer
substituted_quantity	integer
remaining_quantity	integer
reason	string
source	user | rule | import | wms
status	proposed | approved | rejected | applied
proposed_by	string
approved_by	string
metadata	object
created_at	string
updated_at	string

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_line_id": "550e8400-e29b-41d4-a716-446655440000",
    "original_sku": "string",
    "original_product_ref": "string",
    "replacement_sku": "string",
    "replacement_product_ref": "string",
    "requested_quantity": 0,
    "substituted_quantity": 0,
    "remaining_quantity": 0,
    "reason": "string",
    "source": "user",
    "status": "proposed",
    "proposed_by": "string",
    "approved_by": "string",
    "metadata": {},
    "created_at": "2026-07-23T12:00:00Z",
    "updated_at": "2026-07-23T12:00:00Z"
  }
}

400 Invalid request body

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Order not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

409 Substitutions are not allowed for this organization

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

422 Invalid SKU/quantity combination (e.g. exceeds ordered quantity)

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/substitutions

Propose a SKU substitution for an order line

API key (Bearer token)

Request body (JSON){ "order_id": "550e8400-e29b-41d4-a716-446655440000", "order_line_id": "550e8400-e29b-41d4-a716-446655440000", "original_sku": "string", "replacement_sku": "string", "requested_quantity": 0, "substituted_quantity": 0, "reason": "string" }

https://api-test.orderly-hub.com/api/v1/releases/substitutions

Approve or reject a proposed SKU substitution

POST/api/v1/releases/substitutions/{id}/decision

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
decision	approve | reject

{
  "decision": "approve"
}

Responses

200 Substitution decision recorded

Response fields:

Field	Type	Description
id	string
organization_id	string
order_id	string
order_line_id	string
original_sku	string
original_product_ref	string
replacement_sku	string
replacement_product_ref	string
requested_quantity	integer
substituted_quantity	integer
remaining_quantity	integer
reason	string
source	user | rule | import | wms
status	proposed | approved | rejected | applied
proposed_by	string
approved_by	string
metadata	object
created_at	string
updated_at	string

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_line_id": "550e8400-e29b-41d4-a716-446655440000",
    "original_sku": "string",
    "original_product_ref": "string",
    "replacement_sku": "string",
    "replacement_product_ref": "string",
    "requested_quantity": 0,
    "substituted_quantity": 0,
    "remaining_quantity": 0,
    "reason": "string",
    "source": "user",
    "status": "proposed",
    "proposed_by": "string",
    "approved_by": "string",
    "metadata": {},
    "created_at": "2026-07-23T12:00:00Z",
    "updated_at": "2026-07-23T12:00:00Z"
  }
}

400 Invalid request body

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

403 Missing permission release.approve_substitution

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Substitution not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

409 Substitution is not in a decidable (proposed) state

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/substitutions/{id}/decision

Approve or reject a proposed SKU substitution

API key (Bearer token)

id * (path)

Request body (JSON){ "decision": "approve" }

https://api-test.orderly-hub.com/api/v1/releases/substitutions//decision

Get a single order release by id

GET/api/v1/releases/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 The order release

Response fields:

Field	Type	Description
id	string
organization_id	string
order_id	string
destination	BRIDGE_WMS | DISPATCH_LANE
bridge_id	string
fulfillment_location_id	string
status	pending | queued | processing | accepted | ineligible | rejected | failed | cancelled
idempotency_key	string
policy_version	integer
dispatch_assignment_id	string
ownership	object
snapshot	object	Immutable order/lines/ownership snapshot captured at release time
external_wms_order_ref	string
acknowledgement_ref	string
attempt_count	integer
last_error	object
created_by	string
created_at	string
updated_at	string

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "550e8400-e29b-41d4-a716-446655440000",
    "destination": "BRIDGE_WMS",
    "bridge_id": "550e8400-e29b-41d4-a716-446655440000",
    "fulfillment_location_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "pending",
    "idempotency_key": "string",
    "policy_version": 0,
    "dispatch_assignment_id": "550e8400-e29b-41d4-a716-446655440000",
    "ownership": {
      "packing": "WMS",
      "substitution": "WMS",
      "label": "WMS"
    },
    "snapshot": {},
    "external_wms_order_ref": "string",
    "acknowledgement_ref": "string",
    "attempt_count": 0,
    "last_error": {
      "code": "string",
      "message": "string",
      "retryable": true
    },
    "created_by": "string",
    "created_at": "2026-07-23T12:00:00Z",
    "updated_at": "2026-07-23T12:00:00Z"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Release not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

GET/api/v1/releases/{id}

Get a single order release by id

API key (Bearer token)

id * (path)

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

Retry WMS delivery for a failed order release

POST/api/v1/releases/{id}/retry

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Retry re-queued

Response fields:

Field	Type	Description
id	string
status	string

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "queued"
  }
}

401 Missing or invalid credentials

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404 Release not found

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

409 Release is not a failed WMS release and cannot be retried

Response fields:

Field	Type	Description
error	object

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

POST/api/v1/releases/{id}/retry

Retry WMS delivery for a failed order release

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/releases//retry