Create Orders

Create order of different order types (SALES, INBOUND, RETURN, FORWARDING)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint utilizes dynamic processing for warehouse routing. Depending on inventory availability and routing complexity, your request will return either a synchronous confirmation (201 Created) or an asynchronous acknowledgment (202 Accepted).

Response Status Codes

Status CodeStatusDescription
201CreatedOrder Allocated: The order has been successfully received and immediately allocated to a warehouse. No further polling is required to confirm warehouse assignment.
202AcceptedProcessing Pending: The order has been successfully received and queued, but warehouse processing and allocation are still underway.
📘

Handling 202 Accepted Responses

If you receive a 202 Accepted response, the order is safely stored but the fulfillment routing is not yet finalized. You must use the Get Order endpoint (GET /v1/orders/{order_no}) to poll the system and retrieve the updated order status and warehouse allocation details once processing completes.

Example Responses

{
  "code": "SUCCESS",
  "data": {
    "id": "123-123123-123",
    "order_no": "ORD-10293848",
    "status": "WAREHOUSE_ALLOCATED",
    ...
  }
}
{
  "code": "SUCCESS",
  "data": {
    "id": "123-123123-123",
    "order_no": "ORD-10293848",
    "status": "RECEIVED",
    ...
  }
}
Body Params
string
length between 1 and 32

Identifier assigned by upstream ERP or e-commerce platform

string
required
length between 10 and 32

Unique order reference number

string
enum
required

Operation order flow category (currently supports SALES, INBOUND)

Allowed:
string

Specifies shipment delivery methods.

Notice: Shipment code is provided by Cargoholic.

string

Origin country (ISO 3166-1 alpha-2)

string

Destination country (ISO 3166-1 alpha-2)

string

Warehouse requested to process the order.

Notice: warehouse code is provided by Cargoholic.

string

Supplier or vendor identifier for inbound orders

float

Total customs valuation declared for the entire order

string
Defaults to HKD

Three-letter ISO currency code

string

International commercial terms (Incoterms 2020)

boolean
Defaults to false

When set to true, the system will ship all available in-stock items and proceed with fulfillment even if some items are back-ordered or out of stock.

boolean
Defaults to false

Flag indicating if payment is collected on delivery (COD)

float
0 to 9999999999

Cash on delivery amount to be collected

date-time

Expected delivery date requested by the consignee.

string

Special courier or handling instructions

sender
object
required

Sender

consignee
object

Consignee

Required if it's SALES order

lines
array of objects

Order line items, required for SALES and INBOUND orders

Notice: Items should be created on OMS before using them in the orders, otherwise, StatusCode: 409 with ERR_ITEM_NOT_FOUND will be returned

lines
packages
array of objects

Order packages, required for FORWARDING orders

packages
Responses

401

Unauthorized

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json