1、 API Description

Function Create & submit Order via API
Frequency Real-time
Method POST
Type JSON
URI /oms/v1/Order/orderByApi

2、 API Request

2.1、Request Parameters
Field Type Max Length Required Description
ileId String Y ile id
sign String Y ile key
userId String N Customer ID
(If userId is empty, both ileId & sign are required)
method String Y Fixed value “create” for order creation
data Object Y Order request object
amazon_po String N Amazon PO number
amazon_shipment_ids String N Amazon shipment code
fbaWarehouseCode String N FBA warehouse code
(required when channel is “FBA”)
customsDeclarationType int N （The default is 2 - Bill of lading customs declaration） Customs declaration types: 1 - General trade customs declaration, 2 - Bill of lading customs declaration
cbm String Y Order total volume (Unit: CBM)
battery int Y Battery status:
0 - no battery
1 - with battery
2 - pure battery
chargecode String Y Contact ZTL IT staff for details
consignee object Y Consignee information
address String Y Consignee’s detailed address
email String N Consignee’s email
name String Y Consignee’s name
phone String Y Consignee’s phone number
postcode String Y Consignee’s postcode
state String Y Consignee’s state
suburb String Y Consignee’s city/district
cust_ref String N Customer reference for the order
items object Y Information about items in the order
hs String N HS code of the items
name String Y Item name in English
nameZh String Y Item name in Chinese
price String Y Unit price of the items (Unit: USD)
qty String Y Quantity of the items
type String N Type of the items
packs String Y Number of packages in the order
fbaNumber String N Amazon shipment code
referenceId String N Amazon PO number
receiver object N Receiver information
address String N Receiver’s detailed address
company String N Receiver’s company
email String N Receiver’s email
name String N Receiver’s name
phone String N Receiver’s phone number
postcode String N Receiver’s postcode
state String N Receiver’s state
suburb String N Receiver’s city/district
shipper object Y Shipper information
address String Y Shipper’s detailed address
city String Y Shipper’s city
company String Y Shipper’s company
country String Y Shipper’s country
email String Y Shipper’s email
name String Y Shipper’s name
phone String Y Shipper’s phone number
postcode String Y Shipper’s postcode
state String Y Shipper’s province
type integer(int32) Y Default value: 10
weight String Y Order total weight (Unit: KG)
dischargingPort String C Discharge port
(If chargecode starts with P9, origin port is required, e.g., SYD, MEL, BNE, PER)
parcelList List N Information about package dimensions and weight (optional)
(If filled in, must match the number of packs)
barcode String Y Package barcode number
parcelWidth BigDecimal Y Parcel width when entering the warehouse (Unit: CM)
parcelHeight BigDecimal Y Parcel height when entering the warehouse (Unit: CM)
parcelLength BigDecimal Y Parcel length when entering the warehouse (Unit: CM)
parcelWeight BigDecimal Y Parcel weight when entering the warehouse (Unit: KG)
2.2、Request Message Example
{
    "ileId":"your_ileId",
    "sign":"your_sign",
    "method":"create",
    "userId": "your_userId",
    "data":{
        "amazon_po": "213;213;",
        "amazon_shipment_ids": "213;213;",
        "cbm": "1",
        "chargecode": "P12EXP",
        "clear": "DDU",
        "battery": 1,
        "customsDeclarationType": 2,
        "consignee": {
            "address": "zxc",
            "company": "b803, 521 Harris street, Ultimo, Sydney, NSW, 2007",
            "email": "",
            "name": "Eva She",
            "phone": "123456789",
            "postcode": "2007",
            "state": "NSW",
            "suburb": "Ultimo"
        },
        "receiver": {
            "address": "zxc",
            "company": "b803, 521 Harris street, Ultimo, Sydney, NSW, 2007",
            "email": "",
            "name": "Eva She",
            "phone": "123456789",
            "postcode": "2007",
            "state": "NSW",
            "suburb": "Ultimo"
        },
        "cust_ref": "AM3050803000",
        "items": [
            {
                "hs": "213",
                "name": "qwe",
                "nameZh": "中",
                "price": "3",
                "qty": "12",
                "type": "B",
                "fbaNumber": "FBA222222222",
                "referenceId": "123123"
            },
            {
                "type": "B",
                "name_zh": "重试",
                "name": "zx",
                "hs": "213",
                "qty": 12,
                "price": 4,
                "fbaNumber": "FBA222222222,
                "referenceId": "123123"
            }
        ],
        "packs": "21",
        "shipper": {
            "postcode": "200120",
            "email": "",
            "country": "CN",
            "company": "zxc",
            "name": "zzz",
            "state": "zcx",
            "city": "zxc",
            "address": "zxc",
            "phone": "123456789"
        },
        "type": 10,
        "weight": "21",
        "parcelList": [
            {
                "barcode": "test202408260001-1", 
                "parcelWidth": 1.0, 
                "parcelHeight": 2.0, 
                "parcelLength": 3.0, 
                "parcelWeight": 4.0 
            },
            {
                "barcode": "test202408260001-2", 
                "parcelWidth": 1.0, 
                "parcelHeight": 2.0, 
                "parcelLength": 3.0, 
                "parcelWeight": 4.0 
            }
        ]
    }

3、 API Response

3.1、Common Response Parameters
Field Type Max Length Required Description
body object - Y
code integer(int32) - Y
msg string - Y
3.1.1、Response Status
Status Code Description
200 Order submitted successful
201 Created
401 Unauthorized
403 Forbidden
404 Not FoundOK
500 System error
51001 Order parameter validation error
51006 Remotely request productCode failed
3.2、Success Response Example
{
    "body": {
        "id": 2988,
        "orderId": "ILS20231012054224269000042D",    //ZYL order number
        "conCode": "FIT1321003029",    //Order number (Waybill number)
        "refCode": "QNHZ30008780",    //Final Delivery tracking number
        "clientCode": "AM3050803000",    //Customer reference
        "customerId": "1111",    //Customer account ID
        "customerName": "abcd",    //Customer account name
        "productCode": "26219",    //Product/Channel code
        "productName": "Melbourne-Sydney Local Delivery DDU (excluding taxes)",    //Product/Channel name
        "preWeight": 0.22,    //Pre-declared order weight
        "preCbm": 0.1,    //Pre-declared order volume
        "postCode": "2007",    //Consignee postcode
        "preParcelNumber": 1,    //Pre-declared number of packages
        "itemValue": 0,    
        "orderStatus": 1,
        "orderWay": 0,
        "warehouseCode": "ZS",
        "hsDeclarationType": "Customs Declaration",
    },
    "code": 200,
    "msg": ""
}
3.3、 Failure Response Example
{
    "body": {},
    "code": 4001000,
    "msg": ""
}
作者：conghui  创建时间：2024-09-12 14:25
最后编辑：ZYL  更新时间：2025-12-16 17:32