Get Order List

Request Service

  • getFbaOrderList

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":"2",
                  "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>getFbaOrderList</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 N Current page
order_code String N Order code 30
shipping_method String N Shipping Method 50
warehouse_code String N Warehouse Code 20
reference_no String N Reference No 50
order_status String N Order Status. C:Draft W:Pending D:Shipped N:Exception X:Deleted
order_code_arr Object N Order code array 300
is_prime int N Urgent level: 0-None 2-VC order
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":"2",
                  "data":[
                    {
                      "company_code":"AK",
                      "consigne_zipcode":"DN11 0BG",
                      "consignee_city":"Doncaster",
                      "consignee_company":"",
                      "consignee_country_code":"GB",
                      "consignee_country_name":"英国",
                      "consignee_doorplate":"",
                      "consignee_email":"",
                      "consignee_name":"James",
                      "consignee_phone":"123456789",
                      "consignee_state":"Yorkshire",
                      "consignee_street1":"Amazon Fulfillment Center",
                      "date_create":1553496100000,
                      "date_modify":1553496187000,
                      "date_release":1553496100000,
                      "date_shipping":1569310962000,
                      "exception_note":"",
                      "fba_name":"UK FBA-LBA2",
                      "is_prime":"0",
                      "items":[
                        {
                          "product_id":"500704",
                          "product_sku":"AK-20190325001tetest",
                          "quantity":1,
                          "shipped_qty":0,
                          "sku":"20190325001tetest",
                          "sub_tracking_no_items":[
                                  {
                                    "pod_url":"",
                                    "sub_tracking_no":"",
                                    "type":1
                                }
                            ]
                        }
                      ],
                      "order_code":"ZY-AK-190325-0001",
                      "order_desc":"",
                      "order_exception_sub_type":"0",
                      "order_status":"X",
                      "order_weight":"1.000",
                      "outbound_info":{
                        "order_code":"ZY-AK-190325-0001"
                      },
                      "platform":"",
                      "reference_no":"54541685232",
                      "shipping_method":"FEDEX_G_NJ",
                      "tracking_no":"",
                      "warehouse_code":"WPNJ",
                      "warehouse_id":"4",
                      "inventory_type":0,
                      "serial_numbers":[
                        {
                            "serial_number":"987367835435643",
                            "sku":"22-05-09-01"
                        },
                        {
                            "serial_number":"8739873654365436",
                            "sku":"22-05-09-01"
                        }
                      ]
                    },
                    {
                      "company_code":"AK",
                      "consigne_zipcode":"02720-4766",
                      "consignee_city":"Fall River",
                      "consignee_company":"",
                      "consignee_country_code":"US",
                      "consignee_country_name":"美国",
                      "consignee_doorplate":"",
                      "consignee_email":"",
                      "consignee_name":"James",
                      "consignee_phone":"0000000000",
                      "consignee_state":"MA",
                      "consignee_street1":"1180 Innovation Way",
                      "date_create":1553496234000,
                      "date_modify":1553496581000,
                      "date_release":1553496234000,
                      "date_shipping":1553496581000,
                      "exception_note":"",
                      "fba_name":"BOS7",
                      "is_prime":"否",
                      "items":[
                        {
                          "product_id":"500704",
                          "product_sku":"AK-20190325001tetest",
                          "quantity":1,
                          "shipped_qty":0,
                          "sku":"20190325001tetest"
                        }
                      ],
                      "order_code":"ZY-AK-190325-0002",
                      "order_desc":"",
                      "order_exception_sub_type":"0",
                      "order_status":"D",
                      "order_weight":"1.000",
                      "outbound_info":{
                        "bar_code_total_qty":0,
                        "box_mark_total_qty":0,
                        "carton_box_total_qty":0,
                        "extra_label_total_qty":0,
                        "order_code":"ZY-AK-190325-0002",
                        "bol_no":"XY20220621002",
                        "gain_goods_time":1655800602000,
                        "tray_total_qty":0,
                        "truck_logistics_fee":120,
                        "tray_detail":[
                            {
                                "height":7,
                                "length":5,
                                "size_unit":"IN",
                                "tray_qty":9,
                                "weight":8,
                                "weight_unit":"LB",
                                "width":6
                            },
                            {
                                "height":30,
                                "length":10.25,
                                "size_unit":"IN",
                                "tray_qty":50,
                                "weight":40,
                                "weight_unit":"LB",
                                "width":20
                            }
                        ]
                      },
                      "platform":"",
                      "reference_no":"656527546",
                      "shipping_method":"FEDEX_G_NJ",
                      "tracking_no":"1",
                      "warehouse_code":"WPNJ",
                      "warehouse_id":"4",
                      "inventory_type":0,
                      "serial_numbers":[],
                      "intercept_status":0,
                      "warehouse_file":[
                          {
                              "file_url":"aaa",
                            "file_type":"jpg"
                          },
                          {
                              "file_url":"bbb",
                            "file_type":"pdf"
                          }
                      ],
                      "order_product_track_detail":[
                      {
                            "box_no":"",
                            "product_sku":"W1912060004",
                            "tracking_number":"9261290989312151970503"
                    }]
                    }
                  ],
                  "message":"Success",
                  "nextPage":true,
                  "pagination":{
                    "page":1,
                    "pageSize":2
                  }
                }
            </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_company String Company name
consignee_country_code String Country Code
consignee_country_name String Country Name
consignee_doorplate String Doorplate
consignee_email String Emal
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
consignee_district String District
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 note
fba_name String FBA warehouse code
is_prime String Urgent level: 0-None 2-VC order
fee_summery Object Fee summery
order_fee Object Order cost (refer to order_fee parameter)
items Object Response message
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_weight String Order weight
outbound_info Object Outbound Information
platform String Platform， ALIEXPRESS, AMAZON, B2C, EBAY, OTHER
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
serial_numbers Object Serial number (issued)
fba_no String FBA shipment number (corresponding to Amazon backend) Shipment ID)
fba_reference_no String FBA shipment tracking number (corresponding to Amazon backend Shipment ID)
intercept_status Integer Interception status 0: None; 1: Apply for interception; 2: Interception in progress; 3: Interception failed, 4: Interception successful
zone String Logistics zoning (only with the logistics channels of Western Post can there be logistics zoning, while self pickup channels do not have 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)
expected_ship_time String Expected time for goods to be ready
other_address_type_remark String Remarks for other address types (to be filled in when fbaName=Other)
change_packaging int Change packaging 0. No 1. Yes
change_barCode int Change the barcode? 0. No 1. Open the box for replacement 2. Do not open the box for replacement
overlay_barcode int Overwrite barcode 0. No 1. Yes (effective when selecting barcode replacement)
change_shippingMark int Change the box label 0. No, 1. Single sided, 2. Double sided, 3. Four sided
overLay_shippingMark int Cover the box mark 0. No 1. Yes (effective when choosing to change the box mark)
other_requirements Array Other requirements: 1. Loading photos, 2. Additional shipping documents
palletizing int Palletizing 0. No 1. Yes
double_plate int Double board palletizing 0. No 1. Yes
mixed_late int Mix and hold 0. No 1. Yes
tray_mark int 1. No 2. Single sided 3. Double sided 4. Four sided labeling
limit_plate_qty int Limit the number of plates
limit_plate_height BigDecimal Limit plate height
limit_plate_weight BigDecimal Limit plate weight
batch_delivery_order String N
feedback_information Array Feedback 1. Pallet size and weight 2. SKU details for palletizing 3. Pallet photos
palletizing_scheme int Specify SKU palletizing scheme 0. No 1. Yes
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

items：

Parameter Type Remark
product_id String Product ID
product_sku String Product barcode
quantity int Quantity
box_no String Box Number
box_mark_barcode String Box barcode
platform_barcode String Platform barcoe(FNSKU)
package_type String Bag type: ow self packing, RW non self packing
putaway_quantity int Number of shelves
shipped_qty int Shipped qty
sku String SKU
product_barcode String Product barcode
product_name_en String English declaration name
product_declared_value String Declared value

outbound_info：

Parameter Type Remark
order_code String Order Code
box_mark_total_qty int Box mark total
bar_code_total_qty int Label total
extra_label_total_qty int Extra label total
carton_box_total_qty int Carton total
tray_total_qty int Pallet total
truck_logistics_fee Decimal Truck fee (restricted account number is not displayed)
tray_add_time datetime Pallet finish time
warehouse_comments String Warehouse comment
gain_goods_time datetime Pick up time
bol_no String BOL NO
tray_detail Object Pallet details

tray_detail：

Parameter Type Remark
length String Pallet length
width String Pallet width
height String Pallet height
size_unit String Length unit: in / cm
weight String Pallet weight
weight_unit String Weight unit: lb / kg
tray_qty int Number of pallets
sku_details Array Single SKU details

sku_details ：

Parameter Type Remark
product_barcode String Product code
sku_qty int Product quantity

fee_summery：

Parameter Type Remark
order_code String Order code
shipping_method String Shipping method
country_code String Country Code
order_weight String Order weight
ship_cost String Shipping fee
op_cost String Operation fee
fuel_cost String Fuel surcharge
register_cost String Registration fee
warehouse_cost String Storage fee
tariff_cost String Tariff
incidental_cost String Other fee

order_fee：

Parameter Type Remark
type String Type
amount String Amount
currency_code String Currency

warehouse_file：

Parameter Type Remark
file_url String File url
file_type String File type

order_product_track_detail：

Parameter Type Remark
product_sku String SKU
tracking_number String Tracking number
box_no String Case No. / case mark No

serial_numbers：

Parameter Type Remark
sku String SKU
serial_number String serial number

sub_tracking_no_items

Parameter Type Remark
pod_url String pod Download address
sub_tracking_no String Tracking number
type String Type: 1 Main tracking number 2 Sub tracking numbers
作者：WesternPost  创建时间：2021-07-02 21:00
最后编辑：覃超华  更新时间：2024-12-31 02:56