Get Order List

Request Service

  • getOrderList

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>
                {
                  "pageSize":10,
                  "page":1,
                  "reference_no":"",
                  "order_code":"",
                  "order_status":"",
                  "order_type":"0",
                  "order_code_arr":[],
                  "create_date_from":"2019-12-01 10:00:00",
                  "create_date_to":"2019-12-31 10:00:00",
                  "modify_date_from":"2019-12-31 10:00:00",
                  "modify_date_to":"2019-12-31 10:00:00",
                  "ship_date_from":"2019-12-31 10:00:00",
                  "ship_date_to":"2019-12-31 10:00:00",
                  "inventory_type":0
                }
            </paramsJson>
            <appToken>appToken</appToken>
            <appKey>appKey</appKey>
            <service>getOrderList</service>
        </ns1:callService>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request Parameter:

Parameter Type Required Remark Length Limited
pageSize int Y Page size，Max 100
page int Y Current page
reference_no String N Reference no 50
order_code String N Order code 30
order_status String N Order Status. C:Draft W:Pending D:Shipped N:Exception X:Deleted
order_type String N Order type 0:B2C Order 1:B2B Order）
order_code_arr Object N Multiple Order, Array format 300
shipping_method String N Shipping Method 50
create_date_from datetime N Start Date(Create Time)
create_date_to datetime N End Date(Create Time)
modify_date_from datetime N Start Date(Update Time)
modify_date_to datetime N End Date(Update Time)
ship_date_from datetime N Start Date(Ship Time)
ship_date_to datetime N End Date(Ship Time)
inventory_type int N Inventory type: 0: standard; 4: return; 9. All

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>
        <callServiceResponse>
            <response>
                {
                  "ask":"Success",
                  "count":"1",
                  "data":[
                    {
                      "company_code":"AK",
                      "consigne_zipcode":"43125-9084",
                      "consignee_city":"GROVEPORT",
                      "consignee_country_code":"US",
                      "consignee_country_name":"美国",
                      "consignee_name":"Bosh",
                      "consignee_phone":"6148930080",
                      "consignee_state":"OH",
                      "consignee_street1":"4141 HAMILTON SQUARE BLVD",
                      "date_create":1553485803000,
                      "date_modify":1562989966000,
                      "date_release":1553486031000,
                      "date_shipping":1562989967000,
                      "exception_note":"",
                      "is_prime":0,
                      "items":[
                        {
                          "product_id":"500704",
                          "product_sku":"AK-20190325001tetest",
                          "quantity":2,
                          "sku":"20190325001tetest",
                          "sub_tracking_no_items":[
                              {
                                "sub_tracking_no"："794668078172",
                                "type":1,
                                "pod_url":""
                              }
                          ]
                        }
                      ],
                      "order_code":"AK-190325-0001",
                      "order_desc":"",
                      "order_exception_sub_type":"0",
                      "order_status":"D",
                      "order_type":"0",
                      "order_weight":"2.000",
                      "outbound_info":{
                        "order_code":"AK-190325-0001"
                      },
                      "platform":"",
                      "platform_shop":"",
                      "reference_no":"5734113562",
                      "shipping_method":"FEDEX_G_NJ",
                      "tracking_no":"794668078172",
                      "warehouse_code":"WPNJ",
                      "warehouse_id":"4",
                      "inventory_type":0,
                      "sn_list":[
                              {
                                "sku":"",
                                "product_barcode":"",
                                "serial_number":"",
                                "serial_status":"",
                                "receiving_time":"",
                                "out_stock_time":"",
                            }
                      ]
                    }
                  ],
                  "message":"Success",
                  "nextPage":true,
                  "pagination":{
                    "page":1,
                    "pageSize":1
                  }
                }
            </response>
        </callServiceResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response Parameter：

Parameter Type Remark
company_code String Customer code
consigne_zipcode String Postal code
consignee_city String City
consignee_country_code String Country Code
consignee_country_name String Country Name
consignee_name String Name
consignee_phone String Phone
consignee_cell_phone String Recipient extension number
consignee_state String State
consignee_street1 String Address line 1
consignee_street2 String Address line 2
consignee_street3 String Address line 3
date_create datetime Create time
date_modify datetime Update time
date_release datetime Submit time
date_shipping datetime Ship time
local_ship_time datetime Local delivery time
exception_note String Exception
is_prime int Urgent level: 0-None 1-SFP order 2-VC order
is_split int Split order forecast: 1 Yes 0 No
order_code String Order code
order_desc String Order remark
order_exception_sub_type String Exception code
order_status String Order C:Draft W:Pending D:Shipped N:Exception P:Exception(By Warehouse) X:Deleted
order_type String Order type: 0-B2C order 1-B2B order
order_weight String Order weight
platform String Platform
platform_shop String Platform Store
reference_no String Customer reference number
reference_no String Customer reference no
shipping_method String Shipping method
tracking_no String Tracking no
warehouse_code String Warehouse Code
warehouse_id String Warehouse Id
inventory_type int Inventory type: 0: standard; 4: return; 9. All
intercept_status String Intercept Status 0:None 1:apply for intercept 2:intercepting 3:intercept failure 4:intercept success
zone String Logistics zoning
address_type String Address type: 0 None 1 Residential 2 Commercial 3 Unknown 4 Mixed （Currently, only FedEx channels will return this field）
items Object Order items
outbound_info Object FBA order issue information (see outbound_info parameter for details)
sn_list Object Serial number list（see sn_list for details）
outbound_info Object fba Order outbound information (please refer to the outbound info parameter for details)
sn_list Object Order outbound serial number information, this parameter only takes effect for special products that are inbound and outbound according to the serial number (see sn_list parameter for details)
tracking_status int Logistics tracking status: 0 not picked up, 1 picked up, 2 signed for, 3 unknown, 4 returned, 5 abnormal, 6 delayed delivery, 7 arrived for pickup
transportation_date datetime Delivery time
order_placement_time Date Date Format【yyyy-MM-dd HH:mm:ss】，UTC time

items：

Parameter Type Remark
product_id String Product Id
product_sku String Product barcode
quantity int Quantity
sku String Sku
shipped_qty int Shipped qty(only for B2B order)
sub_tracking_no_items Object Tracking number

sub_tracking_no_items：

Parameter Type Remark
sub_tracking_no String Tracking number
type int Type: 1 main tracking number 2 sub tracking number

outbound_info：

Parameter Type Remark
order_code String Transshipment No

sn_list：

Parameter Type Remark
sku String Customer SKU
product_barcode String Product barcode
serial_number String Serial number
serial_status int Serial status：0-pending，10-Received，20-Shipped
receiving_time datetime Inbound Time
out_stock_time datetime OutBound Time
作者：WesternPost  创建时间：2021-07-01 03:20
最后编辑：覃超华  更新时间：2024-12-31 02:56