Create Order

Request Service

  • createOrder

Request Method：

  • POST

Request Sample:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.example.org/">
    <SOAP-ENV:Body>
        <ns1:callService>
            <paramsJson>
                {
                  "platform":"OTHER",
                  "platform_shop":"",
                  "warehouse_code":"WPCHI",
                  "shipping_method":"US_FEDEX_GROUND",
                  "payment_time":"2023-01-01 10:11:12",
                  "reference_no":"ref_1399867101-test",
                  "order_desc":"test-api",
                  "country_code":"US",
                  "province":"CT",
                  "city":"TRUMBULL",
                  "address1":"53 NORTH ST",
                  "zipcode":"142970",
                  "name":"tester",
                  "phone":"123456789",
                  "seller_id":"seller",
                  "inventory_type":0,
                  "verify":1,
                  "order_placement_time":"",
                  "vat_tax_number":"",
                  "items":[
                    {
                      "product_sku":"PTG100016-03",
                      "quantity":"1"
                    },
                  ],
                  "label":{
                        "file_type":"pdf",
                        "file_size":"10x10",
                        "file_data":["base64"]
                    }
                }
            </paramsJson>
            <appToken>appToken</appToken>
            <appKey>appKey</appKey>
            <service>createOrder</service>
        </ns1:callService>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request Parameter:

Parameter Type Required Remark Length Limited
reference_no String Y Reference no 50
platform String N Platform， ALIEXPRESS, AMAZON, B2C, EBAY, OTHER 20
platform_shop String N Platform Store 50
payment_time date N Buyer payment time 50
shipping_method String Y Logistics channel, refer to getShippingMethod (to obtain logistics channel) 30
warehouse_code String Y Shipping warehouse, refer to getWarehouse (to obtain warehouse list), AUTO means the system automatically divides warehouses 20
country_code String Y Recipient country, refer to getCountry (to obtain a list of countries) 20
province String Y State/Province (mandatory for state/province parameters in the United States, not mandatory for European countries) 128
city String Y City 128
address1 String Y Address line 1 1000
address2 String N Address line 2 1000
zipcode String Y Postal code 20
doorplate String N doorplate 32
company String N Company name 360
name String Y Name 200
phone String Y Phone 1 20
cell_phone String N Phone 12 20
email String N Emal 50
sender_po String N Face Sheet PO # (This item will be displayed on the 【 PO Number 】 of the logistics face sheet) 50
sender_ref String NN Face Sheet REF # (This content will be displayed on the 【 REF Number 】 of the logistics face sheet) 50
third_partner_account String N Third party account (set this parameter when fees need to be paid by the third party account) 16
order_cod_currency String N Currency
is_signature int N Signature: 0-No 1-Yes
is_insurance int N Insurance: 0-No 1-Yes
is_prime int N Urgent level: 0-None 1-SFP order 2-VC order
is_split int N Split order forecast or not：0-No 1-Yes
insurance_value int N Insured amount (this item is not enabled, and the insured amount is the declared value of the product)
remark String N Order remark 200
verify int N 0-Save as draft 1: Submit to warehouse
tracking_no String N Tracking no
seller_id String N Seller ID 128
vat_tax_number String N VAT tax number 30
inventory_type int N Inventory type: 0: standard 4: return 9: all (priority return inventory) Note: default 0 standard
items Object Y Order items
label Object N Order attachment 200
order_placement_time Date N Date Format【yyyy-MM-dd HH:mm:ss】，UTC time

items：

Parameter Type Required Remark Length Limited
product_sku String Y SKU 30
platform_transcation_id String N Platform order ID (eBay platform: corresponding ebaytransactionid) 100
platform_item_id String N Platform product ID (eBay platform: corresponding ebayitemid) 100
product_name String N Chinese declaration name 100
product_name_en String N English declaration name 100
product_declared_value BigDecimal N Declared value
quantity int Y Quantity

label：

The file size should not exceed 6M

Parameter Type Required Remark
file_type String N File type(pdf/png/jpg)
file_size String N File size(e.g. 100x150 )
file_data Array[String] N Arry of base64 for file

Response Sample：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SOAP-ENV:Envelope xmlns:ns1="http://www.example.org/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <ns1:callServiceResponse>
            <response>
                {
                  "ask":"Success",
                  "message":"Success",
                  "nextPage":false,
                  "order_code":"XX-191212-0001"
                }
            </response>
        </ns1:callServiceResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response Parameter：

Parameter Type Remark
ask String Request Result: success or failure
message String Response message
nextPage boolean Identify if have next page or not
order_code String System Order Code
Error Object Reference to Error section
作者：WesternPost  创建时间：2021-07-01 04:04
最后编辑：覃超华  更新时间：2024-12-31 02:56