| Level 1 Field | Level 2 Field | Level 3 Field | Type | Length Limit | Meaning | Description | Required | Remark |
|---|
| orderType |
|
| String |
| Order Type | Enumeration: B2C (End-to-end Small Parcel) Fulfillment (Warehouse Dropshipping) | M | When using eTower WMS module, please pass 'Fulfillment' |
| facility |
|
| String | 50 | Sender Facility/Warehouse Code | B2C: Sender facility code; Fulfillment: Warehouse code | M |
|
referenceNo |
|
| String | 50 | Order Unique Code | Used to differentiate orders | M |
|
| originPortCode |
|
| String |
| Origin Port (Airport/Seaport) | English Character Code | O |
|
| injectPortCode |
|
| String | 50 | Destination Port | English Character Code | O |
|
| channelCode |
|
| String | 64 | Channel Name | English & English punctuation | M | Note: When orderType=Fulfillment, use the serviceName returned in in 18. Query Warehouse Service List API where serviceType=5 and active=1 for placing orders |
| channelOption |
|
| String | 64 | Channel Option | English & English punctuation | O |
|
| platform |
|
| String | 20 | Platform | Enumeration: Please fill according to "Platform Names" attachment at the bottom of the page | O |
|
| incoterm |
|
| String | 50 | Trade Term | Enumeration: DDU、DDP | O |
|
| collectionType |
|
|
| 20 | Collection Type | Enumeration: Pickup (door-to-door collection) Drop off (self-delivery to warehouse). Default Drop off if not filled | O |
|
isInsurance |
|
| Boolean | 5 | Whether to Add Insurance | Default false if not filled | O |
|
isSignature |
|
| Boolean | 5 | Whether Signature Required | Default false if not filled | O |
|
| remark |
|
|
| 200 | Remarks |
| O |
|
isOffLineOrder |
|
| Boolean |
| Abandoned Flied |
|
|
|
| isNeedConfirm |
|
| Boolean |
| Whether Auto-Confirm | Default is true. |
| Parameters related to orderType=Fulfillment : true means: Order is auto-confirmed, cannot modify after confirmation; false means: Order is created as draft, can modify; needs to call "8. Forecast Outbound Order" for confirmation |
| extendData |
|
|
|
| Extended Fields | e.g., IOSS, key-value format |
|
|
| consignee | addressCode |
| String | 50 | Consignee Address Code | e.g., ONT8 represents an FBA warehouse |
| Parameters related to orderType=B2C |
| name |
| String | 50 | Consignee Name |
| M |
|
| company |
| String | 512 | Consignee Company |
|
|
|
| phone |
| String | 50 | Consignee Phone |
|
|
|
| email |
| String | 50 | Consignee Email |
|
|
|
| countryCode |
| String | 2 | Destination Country 2-Character Code | English code | M |
|
| state |
| String | 80 | Consignee Province/State |
|
|
|
| city |
| String | 80 | Consignee City |
| M |
|
| district |
| String | 128 | Consignee District |
|
|
|
| addressLine1 |
| String | 200 | Consignee Address Line 1 |
| M |
|
| addressLine2 |
| String | 200 | Consignee Address Line 2 |
|
|
|
| addressLine3 |
| String | 80 | Consignee Address Line 3 |
|
|
|
| zipCode |
| String | 16 | Consignee Postal Code |
|
|
|
| taxId |
| String | 255 | Consignee Tax ID |
|
|
|
| taxId1 |
| String | 255 | Consignee Tax ID1 |
|
|
|
| extendData |
|
|
| Extended Fields |
|
|
|
| shipper | name |
| String | 50 | Shipper Name |
|
| only when orderType=B2C, shipper object can filled and it's optional |
| company |
| String | 512 | Shipper Company |
|
|
| phone |
| String | 50 | Shipper Phone |
|
|
| email |
| String | 50 | Shipper Email |
|
|
| countryCode |
| String | 2 | Origin Country 2-Character Code | English code |
|
| state |
| String | 80 | Shipper Province/State |
|
|
| city |
| String | 80 | Shipper City |
|
|
| district |
| String | 128 | Shipper District |
|
|
| addressLine1 |
| String | 200 | Shipper Address Line 1 |
|
|
| addressLine2 |
| String | 200 | Shipper Address Line 2 |
|
|
| addressLine3 |
| String | 80 | Shipper Address Line 3 |
|
|
| zipCode |
| String | 16 | Shipper Postal Code |
|
|
| taxId |
| String | 255 | Shipper Tax ID |
|
|
| taxId1 |
| String | 255 | Shipper Tax ID1 |
|
|
| extendData |
|
|
| Extended Fields key-value |
|
|
returnAddress | returnOption |
| String | 50 | Return Option | Enumeration: Return, Destroy. |
| only when orderType=B2C, shipper object can filled and it's optional |
| name |
| String | 50 | Return(from) Contact Name |
|
|
| company |
| String | 512 | Return (from) Company Name |
|
|
| phone |
| String | 50 | Return (from) Phone |
|
|
| email |
| String | 50 | Return (from) Email |
|
|
| countryCode |
| String | 2 | Return (from) Country 2-Character Code | English code |
|
| state |
| String | 80 | Return (from) Province/State |
|
|
| city |
| String | 80 | Return (from) City |
|
|
| district |
| String | 128 | Return (from) District |
|
|
| addressLine1 |
| String | 200 | Return(from) Address Line 1 |
|
|
| addressLine2 |
| String | 200 | Return(from) Address Line 2 |
|
|
| addressLine3 |
| String | 80 | Return(from) Address Line 3 |
|
|
| zipCode |
| String | 16 | Return(from) Postal Code |
|
|
| extendData |
| Object |
| Extended Fields |
|
|
| extendData.shippingMethod |
| String | 255 | Extended Fields1 |
|
|
| extendData.xxx |
| String | 255 | Extended Fields2 |
|
|
| parcels | referenceNo |
| String | 80 | Package Reference No |
| M |
|
| referenceNo1 |
| String | 80 | Package Reference No1 |
|
|
|
| referenceNo2 |
| String | 80 | Package Reference No2 |
|
|
|
| consignmentId |
| String | 50 | Package Consignment ID | Australia Post requires MLID+ConsignmentID must not be reused within 2 years |
|
|
| descriptionEn |
| String | 255 | Package Tracking No |
| M | orderType=Fulfillment :Optional; orderType=B2C :Mandatory; |
| description |
| String | 255 | Package Chinese Description |
|
|
|
| dangerousGoods |
| Boolean | 5 | Whether Package is Dangerous Goods | true:Dangerous goods false:Non-dangerous goods |
|
|
| batteryType |
| Boolean | 5 | Package Battery Type | true: With battery false: Without battery |
|
|
| weight |
| BigDecimal | 8,3 | Package Weight | 8 digits, 3 decimal places | M | orderType=Fulfillment :Optional; orderType=B2C :Mandatory; |
| weightUnit |
| String | 2 | Weight Unit | Enumeration: KG (default), G, LB |
|
|
| length |
| BigDecimal | 8,2 | Package Length |
|
|
|
| width |
| BigDecimal | 8,2 | Package Width |
|
|
|
| height |
| BigDecimal | 8,2 | Package Height |
|
|
|
| dimensionUnit |
| String | 8 | Dimension Unit | Enumeration: CM (default), M |
|
|
| invoiceCurrencyCode |
| String | 3 | Invoice Currency Code,3-Character code | English Code |
|
|
| invoiceValue |
| BigDecimal | 20,2 | Invoice Amount |
| M | orderType=Fulfillment :Optional; orderType=B2C :Mandatory; |
| transactionCurrency |
| BigDecimal | 8,2 | Transaction Currency | E-commerce platform transaction currency |
|
|
| transactionAmount |
| BigDecimal | 8,2 | Transaction Amount | E-commerce platform transaction amount |
|
|
| trackingNo |
| String | 80 | Package Tracking No |
|
| Required when orderType=Fulfillment & selected service is offline service If order Label file quantity >1, starting from the 2nd Label, pass the file in "attachments" parameter, filtType=1 represents Label |
| labelType |
| Short |
| Label Type | Enumeration: 0: url 1:base64 | C |
| label |
| String |
| Label |
| C |
| labelName |
| String |
| Label Name | Must include file type, e.g.: outbound order.pdf | C |
| shippingInstruction |
| String | 50 | Shipping Instruction | Will appear on some channel labels |
|
|
| sortCode |
| String | 50 | Sort Code | Will appear on some channel labels |
|
|
| extendData |
| Object |
| Extended Fields | key-value format key:keepShipService value:boolean |
| Can be used only when orderType=Fulfillment; |
|
| String | 255 | Extended Fields |
|
|
|
|
|
|
|
|
|
|
|
attachments | attachName | String | 95 | Attachment Name |
| M | 1.M: If there are attachments, all three fields are required; if no attachments, none are required. 2.Maximum 5 attachments. |
| attachData | String |
| Attachment Content | Base64 format | M |
| attachType | String | 5 | Attachment Extension | Only supports "rar", "zip", "pdf", "doc", "docx", "xls", "xlsx" | M |
| filtType | Integer |
| Attachment Type | Enumeration: 1:Label If not filled or other values: Other | O |
| items | itemNumber | String | 128 | Product Number |
|
|
|
|
|
|
|
|
|
|
| itemDescEn | String | 255 | Product English Description |
|
|
|
| itemDesc | String | 255 | Product Local Description |
|
|
|
| sku | String | 128 | SKU Code |
| M |
|
| hsCode | String | 128 | Customs Code |
|
|
|
| quantity | Integer | 9 | Product Quantity |
| M |
|
| quantityUnit | String | 10 | Product Quantity Unit |
|
|
|
| unitPrice | decimal |
| Unit Price |
|
|
|
| picture | String |
| Image | base64 |
|
|
| salesURL | String | 500 | Sales Link |
|
|
|
| originCountryCode | String | 10 | Origin Country 2-Character Code | English Code |
|
|
| weight | BigDecimal |
| Weight |
|
|
|
| usage | String | 255 | Purpose |
|
|
|
material | String | 255 | Material |
|
|
|
| extendData |
|
| Extended Fields |
|
|
|
insurance (Note: Fill if isInsurance is true) | insuranceType | String | 30 | Insurance Type | Can be used to differentiate different insurance third-party platforms or products |
| Note: Fill if isInsurance is true
|
| beneficiaryType | String | 20 | Beneficiary Type | Enumeration: company, individual |
|
| beneficiary | String | 255 | Beneficiary/Company |
|
|
| beneficiaryId | String | 20 | ID Card/Organization Code Certificate |
|
|
| insuranceCurrencyCode | String | 3 | Insurance 3-Character Currency Code |
|
|
| insuranceAmount | BigDecimal | 20,3 | Insurance Amount |
|
|
| extendData | Object |
| Extended Fields |
|
|
| extendData.UPC | String | 255 | Extended Fields1 |
|
|
| extendData.xx | String | 255 | Extended Fields2 |
|
|
|
|
|
|
|
|
collection
| date |
| date |
| Collection Date | Year-Month-Day |
| Note: Fill if Collection Type is pickup |
| name |
| String | 50 | Customer Name |
|
|
| company |
| String | 512 | Customer Company |
|
|
| phone |
| String | 50 | Customer Phone |
|
|
| email |
| String | 50 | Customer Email |
|
|
| countryCode |
| String | 2 | Customer Country 2-Character Code | English Code |
|
| state |
| String | 80 | Customer Province/State |
|
|
| city |
| String | 80 | Customer City |
|
|
| district |
| String | 128 | Customer District |
|
|
| addressLine1 |
| String | 200 | Customer Address Line 1 |
|
|
| addressLine2 |
| String | 200 | Customer Address Line 2 |
|
|
| addressLine3 |
| String | 80 | Customer Address Line 3 |
|
|
| zipCode |
| String | 16 | Customer Postal Code |
|
|
| extendData |
|
|
| Extended Fields |
|
|