GET Sales Order Detail OMS by Order Number
Last Updated: 31/10/2022
Shipper API gives interface access to our clients for retrieving or pulling Sales Order Detail by ID API from Shipper Warehouse Management System
GET Sales Order Detail for B2C
| Field | Endpoint |
|---|---|
| GET | /v3/fulfillment/warehouse/{warehouse_id}/outbound/oms/{order_no} |
Path Parameter
| Field | Data Type | Description | Notes |
|---|---|---|---|
| order_number | String | Order Number | Mandatory |
| warehouse_code | String | Warehouse code given by Shipper | Mandatory |
Sample Query Parameters Request
| Header | How to fill |
|---|---|
| x-api-key | Shipper Api Key |
/v3/fulfillment/warehouse/WH-TGR04/outbound/oms/TEST123
Sample Body Response
| Header | How to Fill |
|---|---|
| x-request-id | Request ID generated from Shipper for tracking purposes |
{
"metadata": {
"path": "/v3/fulfillment/warehouse/WH-CGK09/outbound/oms/NINATESTING2022071507?%3Aorder_number=NINATESTING2022071507&%3Awarehouse_id=WH-CGK09&",
"http_status_code": 200,
"http_status": "OK",
"timestamp": 1657886350
},
"data": {
"outbound": {
"order_no": "NINATESTING2022071507",
"order_type": "",
"so_status": "",
"warehouse_id": "WH-CGK09",
"consignee_id": "",
"consignee_name": "YOGA",
"release_status": false,
"order_time": "2022-06-08T02:34:56Z",
"wave_no": "",
"so_reference_1": "FO202207151158400738",
"so_reference_2": "NINATESTING2022071507",
"so_reference_3": "",
"so_reference_4": "",
"so_reference_5": "",
"consignee_address_1": "",
"consignee_city": "",
"billing_id": "",
"carrier_name": "JNE REG",
"delivery_no": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"notes": "buyer_remark_ya",
"has_split": true,
"sub_orders": [
{
"order_no": "NINATESTING2022071507",
"order_type": "",
"so_status": "PendingAudit",
"warehouse_id": "WH-CGK09",
"consignee_id": "",
"consignee_name": "YOGA",
"release_status": false,
"order_time": "2022-06-08T02:34:56Z",
"wave_no": "",
"so_reference_1": "",
"so_reference_2": "",
"so_reference_3": "",
"so_reference_4": "",
"so_reference_5": "",
"consignee_address_1": "",
"consignee_city": "",
"billing_id": "",
"carrier_name": "",
"delivery_no": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"notes": "buyer_remark_ya",
"shipper_order_no": "FO202207151159400740",
"original_order_no": "FO202207151158400738",
"waiting_status": "WAIT_MANUAL_OPERATION",
"details": [
{
"sku": "AHNA00010FORADAM-32",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 2,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
}
]
},
{
"order_no": "NINATESTING2022071507",
"order_type": "",
"so_status": "Examined",
"warehouse_id": "WH-CGK09",
"consignee_id": "",
"consignee_name": "YOGA",
"release_status": false,
"order_time": "2022-06-08T02:34:56Z",
"wave_no": "",
"so_reference_1": "",
"so_reference_2": "",
"so_reference_3": "",
"so_reference_4": "",
"so_reference_5": "",
"consignee_address_1": "",
"consignee_city": "",
"billing_id": "",
"carrier_name": "",
"delivery_no": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"notes": "buyer_remark_ya",
"shipper_order_no": "FO202207151159400739",
"original_order_no": "FO202207151158400738",
"waiting_status": "WAIT_CONFIRM_SHIPPING_SETTING",
"details": [
{
"sku": "AHNA00010FORADAM-12",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 10,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
},
{
"sku": "AHNA00010FORADAM-32",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 9,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
},
{
"sku": "AHNA00010FORADAM-31",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 10,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
}
]
}
],
"details": [
{
"sku": "AHNA00010FORADAM-32",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 11,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
},
{
"sku": "AHNA00010FORADAM-31",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 10,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
},
{
"sku": "AHNA00010FORADAM-12",
"order_line": 0,
"line_status": "",
"sku_descr": "",
"qty_ordered": 10,
"qty_released": 0,
"qty_allocated": 0,
"qty_picked": 0,
"qty_shipped": 0,
"pack_id": "",
"udf_01": "",
"udf_02": "",
"udf_03": "",
"udf_04": "",
"udf_05": "",
"mfg_date": null,
"exp_date": null,
"batch_no": null,
"serial_no": null,
"receipt_date": null,
"product_condition": ""
}
]
}
}
}
{
"metadata": {
"path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/oms/TEST123X?%3Aorder_number=TEST123X&%3Awarehouse_id=WH-TGR04&",
"http_status_code": 404,
"http_status": "Not Found",
"errors": [
{
"code": 10004,
"message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
}
],
"timestamp": 1637906128
}
}
{
"metadata": {
"path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/oms/--?%3Aorder_number=--&%3Awarehouse_id=WH-TGR04&",
"http_status_code": 404,
"http_status": "Not Found",
"errors": [
{
"code": 10004,
"message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
}
],
"timestamp": 1637906152
}
}
Add several returned fields:
| Field (new added) | Data Type | Description |
|---|---|---|
| original_shipper_order_no | String(30) | This is to display the parent order’s shipping number for sub orders. |
| has_splitted | Boolean | If true, this order has been split. If false, this order has not been split. It is a normal order. |
| reminder | String | push_automatically: the suborder will push to the system automatically wait_for_shipping_confirm: the suborder wait for shipper confirmation cancel_directly: the suborder will cancel directly cancel_after_days: the suborder will be cancelled after days wait_for_reaction: the suborder wait for reaction (WAIT_MANUAL_OPERATION) no_action_needed: the user does not need to do anything. |
| sub_orders | Array | Will display the suborder information if this order is split. |
| so_status | String | AUDIT AVAILABLE STOCK: The order has been received by shipper system, but has not validated the stock. STOCK AUDIT PASSED: The order has been received by shipper system, and the stock is enough. CREATED: The order is created in the warehouse and waiting to be processed in the warehouse. ALLOCATED: The order has been allocated and waiting to be picked. PICKED: The picking process has been finished in the warehouse. PACKED: The packing process has been finished in the warehouse. SHIPPED: The parcel is ready to be handed over to the delivery company. CLOSED: The order has been closed. Cannot cancel the order anymore. CANCELLED: The order has been cancelled, and will not be processed in the warehouse. |
Updated 12 months ago
What’s Next