1).createOrder

Service capabilities: create the LME order with the pre-order no

request url:host:port/server/gateway/order/create

SDK request class:CreateOrderRequest

parameter data:

parameter name	description	is required	parameter type
outOrderNo	generated by channel, unique	TRUE	string
channel	channel code, same as appkey	TRUE	string
orderNo	auto-allocated, but other than that it can be pre-allocated in vender IT system with this format: ‘vender code’+14 numbers, such as FHE16753011400000	FALSE	string
preTimeStart	yyyy-MM-dd HH:mm:ss，expect delivery start time，not work, greater than current date time	TRUE	string
preTimeEnd	yyyy-MM-dd HH:mm:ss，expect delivery end time，not work, greater than current date time	TRUE	string
cargoDesc	the description of cargo	FALSE	string
source	order source	FALSE	string
cargoDetail	the description detail of cargo	FALSE	string
totalLength	packet length, unit: m，max:2m	TRUE	number
totalWidth	packet width, unit: m，max:2m	TRUE	number
totalHeight	packet height, unit: m，max:2m	TRUE	number
totalWeight	packet weight, unit: kg	TRUE	number
baleNo	consolidation of multiple orderNo, usually MAWB	FALSE	string
remark	order remark	FALSE	string
poster		TRUE	Poster
company	poster company nam	FALSE	string
contact	poster name	TRUE	string
tel	poster tel, required between tel and mobile, fill with '123456789' if both null	FALSE	string
mobile	poster mobile, required between tel and mobile, fill with '123456789' if both null	FALSE	string
zoneCode	poster address zone code， ISO-3361, demo：AU	TRUE	string
country	poster country full name, demo：Australia	TRUE	string
province	poster province full name, demo：New South Wales	TRUE	string
city	poster name	TRUE	string
county	poster county full name	FALSE	string
address	poster address full name, max 40 length	TRUE	string
addressType	poster address type	FALSE	int32
postCode	poster address post code	TRUE	string
gps	poster address gps	FALSE	string
taxNo	poster tax number	FALSE	string
receiver		TRUE	Receiver
company	receiver company name	FALSE	string
contact	receiver name	TRUE	string
tel	receiver tel, required between tel and mobile, fill with '123456789' if both null	TRUE	string
mobile	receiver mobile, required between tel and mobile, fill with '123456789' if both null	TRUE	string
email	receiver email	FALSE	string
zoneCode	receiver address zone code， ISO-3361, demo：AU	TRUE	string
country	receiver country full name, demo：Australia	TRUE	string
province	receiver province full name, demo：New South Wales	TRUE	string
city	receiver city full name	TRUE	string
county	receiver county full name	FALSE	string
address	receiver address full name, max 40 length	TRUE	string
addressType	receiver address Type	FALSE	int32
postCode	receiver post Code	TRUE	string
gps	receiver address gps	FALSE	string
taxNo	receiver tax no	FALSE	string
noteContent	receiver notes	FALSE	string
returnAddress	The return address	false	ReturnAddress
company	poster company name	FALSE	string
contact	poster name，required if returnAddress is not null	TRUE	string
tel	poster tel, required between tel and mobile, fill with '123456789' if both null，required if returnAddress is not null	FALSE	string
mobile	poster mobile, required between tel and mobile, fill with '123456789' if both null，required if returnAddress is not null	FALSE	string
zoneCode	poster address zone code， ISO-3361, demo：AU，required if returnAddress is not null	TRUE	string
country	poster country full name, demo：Australia，required if returnAddress is not null	TRUE	string
province	poster province full name, demo：New South Wales，required if returnAddress is not null	TRUE	string
city	poster name，required if returnAddress is not null	TRUE	string
county	poster county full name	FALSE	string
address	poster address full name, max 40 length，required if returnAddress is not null	TRUE	string
addressType	poster address type	FALSE	int32
postCode	poster address post code，required if returnAddress is not null	TRUE	string
gps	poster address gps	FALSE	string
taxNo	poster tax number	FALSE	string
orderSkuInfoList		FALSE	array[OrderSkuInfo]
productNo		FALSE	string
skuNo		FALSE	string
parcelQty		FALSE	int32
totalCost		FALSE	number
totalCostExGst		FALSE	number
totalGst		FALSE	number
length		FALSE	number
width		FALSE	number
height		FALSE	number
volume		FALSE	number
totalWeight		FALSE	number
remark		FALSE	string

demo:

{
    "outOrderNo":"",
    "channel":"",
    "preTimeStart":"",
    "preTimeEnd":"",
    "cargoDesc":"",
    "cargoDetail":"",
    "totalLength":0,
    "totalWidth":0,
    "totalHeight":0,
    "totalWeight":0,
    "baleNo":"baleNo",
    "remark":"",
    "poster":{
        "company":"",
        "contact":"",
        "tel":"",
        "mobile":"",
        "email":"",
        "zoneCode":"",
        "country":"",
        "province":"",
        "city":"",
        "county":"",
        "address":"",
        "addressType":0,
        "postCode":"",
        "gps":"",
        "taxNo":""
    },
    "receiver":{
        "company":"",
        "contact":"",
        "tel":"",
        "mobile":"",
        "email":"",
        "zoneCode":"",
        "country":"",
        "province":"",
        "city":"",
        "county":"",
        "address":"",
        "addressType":0,
        "postCode":"",
        "gps":"",
        "taxNo":""
    },
    "returnAddress":{
        "company":"",
        "contact":"",
        "tel":"",
        "mobile":"",
        "email":"",
        "zoneCode":"",
        "country":"",
        "province":"",
        "city":"",
        "county":"",
        "address":"",
        "addressType":0,
        "postCode":"",
        "gps":"",
        "taxNo":""
    },
    "orderSkuInfoList":[
        {
            "productNo":"",
            "skuNo":"",
            "parcelQty":0,
            "totalCost":0,
            "totalCostExGst":0,
            "totalGst":0,
            "length":0,
            "width":0,
            "height":0,
            "volume":0,
            "totalWeight":0,
            "remark":""
        }
    ]
}

SDK response class:OpResponse

response data:

parameter name	description	parameter type	required
code	refer to the section 'error code mapping'	int32	true
message		string
displayable		boolean
data		OrderResponseDTO	required with 0 code
orderNo		string	true
outOrderNo		string	true
channel		string	true
parcelQty		int32	false
preTimeStart		string	true
preTimeEnd		string	true
cargoDesc		string	false
cargoDetail		string	false
totalLength		number	true
totalWidth		number	true
totalHeight		number	true
volume		number	true
totalWeight		number	true
totalNetWeight		number	true
orderStage	see the status flow	int32	true
stageStatus	see the status flow	int32	true
preDeliverWarehouseName	Deliver Warehouse Name	string	false, if null please filled wiht value NONE
baleNo		string	false
remark		string	false
packageType		PackageType	false
packageCode		int32	false
packageType		string	false
packageInternationalId		string	false
poster		ContactResponseDTO	true
company		string	false
contact		string	true
tel		string	false
mobile		string	false
email		string	false
zoneCode		string	true
country		string	true
province		string	true
city		string	false
county		string	false
address		string	true
postCode		string	true
gps		string	false
taxNo		string	false
addressType		int32	false
receiver		ContactResponseDTO	true
company		string	false
contact		string	true
tel		string	false
mobile		string	false
email		string	false
zoneCode		string	true
country		string	true
province		string	true
city		string	false
county		string	false
address		string	true
postCode		string	true
gps		string	false
taxNo		string	false
addressType		int32	false
returnAddress		ContactResponseDTO	false
company		string
contact		string
tel		string
mobile		string
email		string
zoneCode		string
country		string
province		string
city		string
county		string
address		string
postCode		string
gps		string
taxNo		string
addressType		int32
success		boolean
demo:

    {
    "code":0,
    "message":"",
    "displayable":true,
    "data":{
        "id":"",
        "orderNo":"",
        "outOrderNo":"",
        "channel":"",
        "parcelQty":0,
        "preTimeStart":"",
        "preTimeEnd":"",
        "cargoDesc":"",
        "cargoDetail":"",
        "totalLength":0,
        "totalWidth":0,
        "totalHeight":0,
        "volume":0,
        "totalWeight":0,
        "totalNetWeight":0,
        "orderStage":0,
        "stageStatus":0,
        "preDeliverWarehouseName":"",
        "remark":"",
        "packageType":{
            "packageCode":0,
            "packageType":"",
            "packageInternationalId":""
        },
        "poster":{
            "orderNo":"",
            "company":"",
            "contact":"",
            "tel":"",
            "mobile":"",
            "email":"",
            "zoneCode":"",
            "country":"",
            "province":"",
            "city":"",
            "county":"",
            "address":"",
            "postCode":"",
            "gps":"",
            "taxNo":"",
            "addressType":0
        },
        "receiver":{
            "orderNo":"",
            "company":"",
            "contact":"",
            "tel":"",
            "mobile":"",
            "email":"",
            "zoneCode":"",
            "country":"",
            "province":"",
            "city":"",
            "county":"",
            "address":"",
            "postCode":"",
            "gps":"",
            "taxNo":"",
            "addressType":0
        },
        "returnAddress":{
            "orderNo":"",
            "company":"",
            "contact":"",
            "tel":"",
            "mobile":"",
            "email":"",
            "zoneCode":"",
            "country":"",
            "province":"",
            "city":"",
            "county":"",
            "address":"",
            "postCode":"",
            "gps":"",
            "taxNo":"",
            "addressType":0
        }
    },
    "success":true
}