OMS API

CommerceLab Order Management System (OMS) API. Used to transfer orders from your sales channel to OMS, retrieve shipment packages and update status/invoice/shipping information, and manage cancellation and return processes.

Getting Started

1. Call the Get Token endpoint (POST /Auth/login) with the provided API user.
2. Send the returned token in the Authorization: Bearer <token> header for all subsequent requests.
3. Test in the Test environment first; only the server address and user change when switching to Prod.

Typical flow

Save order → List order packages → Write package client status → Write invoice info / Write shipping info / Update package status → if needed Cancel / Return endpoints. Package and request status changes are notified to you via webhook.

Error model

• HTTP 200 + isSuccess: false — business rule error (record not found, status not valid, etc.). Message is in the errorMesssage field (field name is spelled with three s in the source). Check the isSuccess field in every response.
• HTTP 400 — body/parameter validation error (ValidationProblemDetails). This error occurs if required fields marked in the document are sent empty.
• HTTP 401 — token missing, invalid, or expired.
• HTTP 500 — unexpected error; response body uses PascalCase field names (IsSuccess, ErrorMesssage).

JSON field names are case-insensitive in requests; responses return camelCase.

Environments

• Test: https://api.oms.awstest.hebiar.com
• Prod: https://api.oms.prod.hebiar.com

Authentication

• POST /Auth/login — Get token

Orders

• POST /Orders/SaveOrders — Save order
• POST /Orders/SetOrderClientStatus — Write order client status
• POST /Orders/SetErpInfoList — Write ERP information

Packages

• POST /OrderPackage/CreatePackage — Create package
• GET /Orders/GetOrderPackages — List order packages
• POST /OrderPackage/SetPackageClientStatus — Write package client status
• POST /OrderPackage/SetOrderPackageStatusInfoList — Update package status (bulk)
• POST /OrderPackage/SetOrderPackageInvoiceInfoList — Write invoice information
• POST /OrderPackage/SetOrderPackageCargoInfoList — Write shipping information

Package Splitting

• POST /OrderPackage/shipment-packages/{shipmentPackageId}/split — Split package (line-based)
• POST /OrderPackage/shipment-packages/{shipmentPackageId}/multi-split — Split the package into groups
• POST /OrderPackage/shipment-packages/{shipmentPackageId}/quantity-split — Split package by quantity
• POST /OrderPackage/shipment-packages/{shipmentPackageId}/split-packages — Create new packages with quantities from the package

Cancel & Return

• POST /Orders/CreateOrderItemLineCancelRequest — Create cancellation request
• POST /Orders/CancelOrderItemLineList — Cancel line
• POST /Return/CreateReturnRequest — Create return request
• GET /Orders/GetReturnOrderPackages — List return packages

Definitions

• GET /Lookup/OrderStatusReasonByTenant/GetStatusReasonByType — List status reasons