创建订单--createOrder

POST

/default/svc/web-service

createOrder

1.必填项并非固定
2.如无特殊说明，重量单位为kg，长度单位为cm
3.如果响应结果中的track_status为2，表示需要调用获取跟踪号接口异步获取跟踪号
4.请求参数里面如果包含>、&，需要转义成对应的实体>、&，或者paramsJson节点的内容使用＜![CDATA[ ]]＞标签忽略解析

请求参数

Body 参数application/xml

reference_no

string

客户单号

必需

<= 50 字符

示例值:

TEST123456

shipping_method

string

运输方式

必需

country_code

string

国家代码

必需

<= 2 字符

示例值:

extra_service

string | null

额外服务

可选

order_weight

number

必需

订单总重，全部箱子重量之和，单位kg

shipping_method_no

string | null

跟踪号

可选

order_pieces

integer

必需

总件数，全部箱子数量之和

insurance_value

number | null

保险金额

可选

mail_cargo_type

enum<string> | enum<null>

申报类型

可选

枚举值:

1234

默认值:

cargo_type

enum<string> | enum<null>

包裹类型

可选

枚举值:

WDL

默认值:

is_COD

enum<string> | enum<null>

可选

>= 0 字符<= 1 字符

枚举值:

示例值:

sales_amount

number | null

COD订单金额

可选

sales_currency

string | null

COD订单金额币种

可选

<= 3 字符

示例值:

USD

seller_id

string | null

卖家ID

可选

buyer_id

string | null

买家ID

可选

invoice_fee

number | null

发票运费

可选

other_fee

number | null

其他费用

可选

warehouse_code

string

FBA仓库代码

可选

platform_number

string | null

平台单号

可选

<= 50 字符

ioss

string | null

可选

欧盟进口税号IOSS

customs_declaration_type

string | null

可选

报关方式通过getBasicData接口获取

customs_clearance_type

string | null

可选

清关方式通过getBasicData接口获取

Consignee

object

收件人节点

必需

consignee_company

string | null

收件人公司名

可选

consignee_name

string

收件人姓名

必需

consignee_doorplate

string | null

收件人门牌号

可选

consignee_street

string

收件人地址1

必需

consignee_street2

string | null

收件人地址2

可选

consignee_street3

string | null

收件人地址3

可选

consignee_district

string | null

收件人县区

可选

consignee_city

string

收件人城市

必需

consignee_province

string | null

可选

收件人州省美国、加拿大地址必填

consignee_postcode

string

必需

收件人邮编大部分国家地区必填

consignee_telephone

string | null

收件人电话

可选

consignee_mobile

string | null

收件人手机

可选

consignee_email

string | null

收件人邮箱

可选

consignee_certificatetype

enum<string> | enum<null>

收件人证件类型

可选

<= 2 字符

枚举值:

IDPP

consignee_certificatecode

string | null

收件人证件号码

可选

consignee_credentials_period

string | null

收件人证件有效期

可选

示例值:

2024-12-31

consignee_passport_address

string | null

收件人护照签发地

可选

consignee_taxno

string | null

收件人税号

可选

consignee_taxno_type

enum<string> | enum<null>

收件人税号类型

可选

枚举值:

1234

consignee_eori

string | null

收件人EORI

可选

Shipper

object | null

发件人节点

必需

shipper_name

string

发件人姓名

必需

shipper_company

string | null

发件人公司名

可选

shipper_doorplate

string | null

发件人门牌号

可选

shipper_street

string

发件人地址1

必需

shipper_street2

string | null

发件人地址2

可选

shipper_street3

string | null

发件人地址3

可选

shipper_city

string

发件人城市

必需

shipper_province

string | null

发件人省份

可选

shipper_postcode

string

发件人地址邮编

必需

shipper_telephone

string | null

发件人电话

可选

shipper_mobile

string | null

发件人手机

可选

shipper_email

string | null

发件人邮箱

可选

shipper_fax

string | null

发件人传真

可选

shipper_tax_number

string | null

发件人税号

可选

shipper_tax_number_type

enum<string> | enum<null>

发件人税号类型

可选

枚举值:

1234

shipper_eori

string | null

发件人EORI

可选

shipper_certificatecode

string | null

发件人证件号码

可选

shipper_certificatetype

enum<string> | enum<null>

发件人证件类型

可选

枚举值:

IDPP

ItemArr

array [object {27}]

申报信息节点

必需

box_number

string | null

可选

箱号，不填默认U001一票多件时需要传值，与Volume节点的箱号对应

invoice_enname

string

英文品名

必需

invoice_cnname

string | null

中文品名

可选

invoice_weight

number

申报单重，单位kg

必需

invoice_quantity

integer

申报数量

必需

>= 1

unit_code

enum<string> | enum<null>

申报单位

可选

枚举值:

PCEPCSSETMTR

invoice_unitcharge

number

申报单价

必需

invoice_currencycode

string | null

申报币种

可选

示例值:

USD

hs_code

string | null

海关编码

可选

invoice_note

string | null

配货信息

可选

invoice_url

string | null

销售链接

可选

sku

string | null

SKU

可选

material

string | null

中文材质

可选

material_enture

string | null

英文材质

可选

product_id

string | null

产品ID

可选

transaction_id

string | null

交易ID

可选

use

string | null

用途

可选

invoice_brand

string | null

品牌

可选

invoice_brand_type

enum<string> | enum<null>

品牌类型

可选

枚举值:

NBTTBTABTPBTOBT

invoice_category

string | null

品类

可选

invoice_model

string | null

型号

可选

is_magnetoelectric

enum<string> | enum<null>

是否带磁带电

可选

枚举值:

NYEM

note

string | null

备注1

可选

note2

string | null

备注2

可选

deal_price

number | null

成交价

可选

deal_currencycode

string

成交价币种

必需

<= 3 字符

示例值:

USD

country_of_origin

string | null

原产国

可选

示例值:

Volume

array [object {7}]

必需

箱子节点，小包订单可不传此节点

box_number

string | null

可选

箱号，默认为U001，如果传值需要与itemArr里的申报信息箱号对应

<= 50 字符

child_number

string | null

子单号

可选

<= 50 字符

reference_id

string | null

可选

FBA reference ID

<= 50 字符

shipment_id

string | null

可选

FBA shipment ID

<= 50 字符

length

number | null

长度，单位cm

可选

width

number | null

宽度，单位cm

可选

height

number | null

高度，单位cm

可选

示例

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.example.org/Ec/">
    <SOAP-ENV:Body>
        <ns1:callService>
            <paramsJson>
                <![CDATA[
                    {
    "reference_no": "{{reference_no}}",
    "shipping_method": "{{shipping_method}}",
    "country_code": "CA",
    "extra_service": "",
    "order_weight": 18.51,
    "shipping_method_no": "",
    "order_pieces": 2,
    "insurance_value": "",
    "mail_cargo_type": 4,
    "cargo_type": "W",
    "is_COD": "N",
    "sales_amount": "",
    "sales_currency": "",
    "seller_id": "",
    "buyer_id": "",
    "payment_type": "",
    "invoice_fee": null,
    "other_fee": null,
    "reference_id": "",
    "shipment_id": "",
    "POANumber": "",
    "warehouse_code": "",
    "platform": "",
    "platform_number": "",
    "ioss": "",
    "Consignee": {
        "consignee_company": "consignee company",
        "consignee_province": "BC",
        "consignee_city": "RICHMOND",
        "consignee_street": "14967 Salt Lake Ave",
        "consignee_street2": "",
        "consignee_postcode": "V7C4V7",
        "consignee_name": "consignee name",
        "consignee_telephone": "+6584884901",
        "consignee_mobile": "+6584884901",
        "consignee_email": "test@qq.com",
        "buyer_id": ""
    },
    "ItemArr": [
        {
            "box_number":"U001",
			"invoice_enname": "3D printer filament",
            "invoice_cnname": "3D打印线材",
            "invoice_weight": 1.390,
            "invoice_quantity": 1,
            "unit_code": "PCE",
            "invoice_unitcharge": 15.99,
            "invoice_currencycode": "USD",
            "deal_price": 14.0000,
            "deal_currencycode": "USD",
            "hs_code": "39169090",
            "invoice_note": "",
            "invoice_url": "",
            "sku": "A01-W2-1.75-1000-SPL",
            "shop_sku": "",
            "box_number": "",
            "material": "",
            "material_enture": "",
            "product_id": "",
            "transaction_id": "",
            "use": "",
            "invoice_brand": "",
            "invoice_brand_type": "",
            "invoice_category": "",
            "invoice_model": "",
            "is_magnetoelectric": "N",
            "country_of_origin": "CN",
            "note": "",
            "note2": ""
        },
        {
            "box_number":"U002",
			"invoice_enname": "3D printer filament",
            "invoice_cnname": "3D打印线材",
            "invoice_weight": 1.394,
            "invoice_quantity": "1",
            "unit_code": "PCE",
            "invoice_unitcharge": 15.99,
            "invoice_currencycode": "USD",
            "deal_price": 14.0000,
            "deal_currencycode": "USD",
            "hs_code": "39169090",
            "invoice_note": "",
            "invoice_url": "",
            "sku": "A00-D0-1.75-1000-spl",
            "shop_sku": "",
            "box_number": "",
            "material": "",
            "material_enture": "",
            "product_id": "",
            "transaction_id": "",
            "use": "",
            "invoice_brand": "",
            "invoice_brand_type": "",
            "invoice_category": "",
            "invoice_model": "",
            "is_magnetoelectric": "N",
            "country_of_origin": "CN",
            "note": "",
            "note2": ""
        }
    ],
    "Shipper": {
        "shipper_countrycode": "JP",
        "shipper_province": "",
        "shipper_city": "Tokyo",
        "shipper_street": "10 FedEx Parkway",
        "shipper_doorplate": "5/F",
        "shipper_telephone": "13800138000",
        "shipper_name": "shipper name",
        "shipper_company": "shipper company",
        "shipper_postcode": "1690051",
        "shipper_email": "test@gmail.com"
    },
    "Volume": [
        {
            "box_number":"U001",
			"length": 50,
            "width": 37,
            "height": 23,
            "weight": 14.01
        },
        {
            "box_number":"U002",
			"length": 25,
            "width": 25,
            "height": 23,
            "weight": 4.5
        }
    ]
}
                ]]>
            
            </paramsJson>
            <appToken>{{appToken}}</appToken>
            <appKey>{{appKey}}</appKey>
            <service>createOrder</service>
        </ns1:callService>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://8.129.234.2:8085/default/svc/web-service' \
--header 'Content-Type: application/xml' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.example.org/Ec/">
    <SOAP-ENV:Body>
        <ns1:callService>
            <paramsJson>
                <![CDATA[
                    {
    "reference_no": "{{$string.alphanumeric}}",
    "shipping_method": "PK0231",
    "country_code": "CA",
    "extra_service": "",
    "order_weight": 18.51,
    "shipping_method_no": "",
    "order_pieces": 2,
    "insurance_value": "",
    "mail_cargo_type": 4,
    "cargo_type": "W",
    "is_COD": "N",
    "sales_amount": "",
    "sales_currency": "",
    "seller_id": "",
    "buyer_id": "",
    "payment_type": "",
    "invoice_fee": null,
    "other_fee": null,
    "reference_id": "",
    "shipment_id": "",
    "POANumber": "",
    "warehouse_code": "",
    "platform": "",
    "platform_number": "",
    "ioss": "",
    "Consignee": {
        "consignee_company": "consignee company",
        "consignee_province": "BC",
        "consignee_city": "RICHMOND",
        "consignee_street": "14967 Salt Lake Ave",
        "consignee_street2": "",
        "consignee_postcode": "V7C4V7",
        "consignee_name": "consignee name",
        "consignee_telephone": "+6584884901",
        "consignee_mobile": "+6584884901",
        "consignee_email": "test@qq.com",
        "buyer_id": ""
    },
    "ItemArr": [
        {
            "box_number":"U001",
			"invoice_enname": "3D printer filament",
            "invoice_cnname": "3D打印线材",
            "invoice_weight": 1.390,
            "invoice_quantity": 1,
            "unit_code": "PCE",
            "invoice_unitcharge": 15.99,
            "invoice_currencycode": "USD",
            "deal_price": 14.0000,
            "deal_currencycode": "USD",
            "hs_code": "39169090",
            "invoice_note": "",
            "invoice_url": "",
            "sku": "A01-W2-1.75-1000-SPL",
            "shop_sku": "",
            "box_number": "",
            "material": "",
            "material_enture": "",
            "product_id": "",
            "transaction_id": "",
            "use": "",
            "invoice_brand": "",
            "invoice_brand_type": "",
            "invoice_category": "",
            "invoice_model": "",
            "is_magnetoelectric": "N",
            "country_of_origin": "CN",
            "note": "",
            "note2": ""
        },
        {
            "box_number":"U002",
			"invoice_enname": "3D printer filament",
            "invoice_cnname": "3D打印线材",
            "invoice_weight": 1.394,
            "invoice_quantity": "1",
            "unit_code": "PCE",
            "invoice_unitcharge": 15.99,
            "invoice_currencycode": "USD",
            "deal_price": 14.0000,
            "deal_currencycode": "USD",
            "hs_code": "39169090",
            "invoice_note": "",
            "invoice_url": "",
            "sku": "A00-D0-1.75-1000-spl",
            "shop_sku": "",
            "box_number": "",
            "material": "",
            "material_enture": "",
            "product_id": "",
            "transaction_id": "",
            "use": "",
            "invoice_brand": "",
            "invoice_brand_type": "",
            "invoice_category": "",
            "invoice_model": "",
            "is_magnetoelectric": "N",
            "country_of_origin": "CN",
            "note": "",
            "note2": ""
        }
    ],
    "Shipper": {
        "shipper_countrycode": "JP",
        "shipper_province": "",
        "shipper_city": "Tokyo",
        "shipper_street": "10 FedEx Parkway",
        "shipper_doorplate": "5/F",
        "shipper_telephone": "13800138000",
        "shipper_name": "shipper name",
        "shipper_company": "shipper company",
        "shipper_postcode": "1690051",
        "shipper_email": "test@gmail.com"
    },
    "Volume": [
        {
            "box_number":"U001",
			"length": 50,
            "width": 37,
            "height": 23,
            "weight": 14.01
        },
        {
            "box_number":"U002",
			"length": 25,
            "width": 25,
            "height": 23,
            "weight": 4.5
        }
    ]
}
                ]]>
            
            </paramsJson>
            <appToken>a106eb7a118d78f92cabbc91586caa84</appToken>
            <appKey>a106eb7a118d78f92cabbc91586caa8401ac591bb285b42966f035d8d49a7b5c</appKey>
            <service>createOrder</service>
        </ns1:callService>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>'

返回响应

🟢200成功

application/xml

Body

ask

enum<string>

结果状态

必需

枚举值:

SuccessFailure

message

string

结果提示信息

必需

reference_no

string

客户单号

必需

shipping_method_no

string | null

尾程跟踪号

可选

agent_number

string | null

渠道转单号

可选

order_code

string

系统运单号

必需

system_number

string

第三方系统单号

可选

track_status

integer

必需

跟踪号生成状态，为2时需要异步获取跟踪号

sender_info_status

enum<integer>

公共发件人分配状态

必需

枚举值:

ODA

enum<string> | enum<null>

可选

是否为偏远地址，Y是N否

枚举值:

YNnull

tracking_number_list

object

必需

xxx

string | null

可选

对应Volume的箱号

yyy

string | null

子单跟踪号

可选

time_cost(s)

string

耗时，单位秒

必需

示例

成功示例失败示例

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.example.org/Ec/"><SOAP-ENV:Body><ns1:callServiceResponse><response>{"ask":"Success","message":"Success","reference_no":"e9W0ftAdbpEkTe2zZDn7","shipping_method_no":"794813650212","order_code":"CR36600006","track_status":1,"sender_info_status":0,"ODA":null,"agent_number":"","system_number":null,"tracking_number_list":{"U001":"794813650212","U002":"794813650223"},"time_cost(s)":11.210399866104}</response></ns1:callServiceResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>

🟢200失败

修改于 2025-01-02 03:13:00

获取跟踪号--getTrackNumber