Page Comparison

接口说明：

...

查询订单列表时可使用的一些过滤字段:

...

status

...

字符串，只能是 'PREPARING','RECEIVED','PENDING','WAIT_PICKING','PICKING','PROCESSING',

'REVIEWING','FINISHED','DELETED','CANCELLED','PROBLEM','WAITING_CLIENT_RESPOND',

'WAITING_WAREHOUSE_RESPOND','ADDRESS_LABEL_PRINTED','CONFIRMED_BY_WAREHOUSE'　这些值中的任意一个

...

type

...

consignment_product_reference

...

delivery_reference

...

请求示例：

Code Block

title	查询订单请求示例

http://branch.birdsystem.com/client/consignment?status=FINISHED    //返回已完成状态的所有订单

接口返回示例：

Code Block

title	查询返回示例

{
    "total": 2,
    "data": [
        {
            "commodity_code": null,
            "total_price_customs_export": null,
            "name_customs": null,
            "total_quantity": null,
            "weight": null,
            "price": null,
            "price_customs_export": null,
            "period": null,
            "type": "LOCAL",
            "total": null,
            "external_code": null,
            "external_code1": null,
            "external_code2": null,
            "max_length": null,
            "max_width": null,
            "max_depth": null,
            "handling_fee_first_item": null,
            "handling_fee_other_item": null,
            "handling_fee_first_product": null,
            "handling_fee_other_product": null,
            "handling_fee": null,
            "handling_fee_urgent_consignment": null,
            "handling_fee_limit": null,
            "delivery_fee": null,
            "delivery_fee_type": null,
            "return_consignment_id": null,
            "return_consignment_action_type": null,
            "return_consignment_action_name": null,
            "quantity": null,
            "battery_type_name_list": null,
            "battery_type_id_list": null,
            "delivery_service_name": "Yodel Tracked（特惠）",
            "sku_count": null,
            "product_company_ref": null,
            "id": 2010290360000089,
            "company_id": 36,
            "client_id": 47,
            "warehouse_id": 80,
            "consignment_product_quantity": "1",
            "consignment_product_reference": "2989068",
            "delivery_service_id": 5867,
            "delivery_service_id_internal": 5867,
            "delivery_package_size_id": 617,
            "total_price": "0.00",
            "total_delivery_fee": "0.00",
            "total_handling_fee": "2.00",
            "length": "0.00",
            "width": "0.00",
            "depth": "0.00",
            "total_weight": 2000,
            "total_volume": "8000.00",
            "total_volume_weight": 1,
            "total_fee_weight": 2000,
            "guarantee_percentage": "0.00",
            "contact": "Heather Howe",
            "business_name": null,
            "address_line1": "3 Clun Close",
            "address_line2": null,
            "address_line3": null,
            "city": "Telford",
            "county": "Shropshire",
            "post_code": "tf13hx",
            "country_iso": "GB",
            "telephone": "01952400359",
            "email": "heatherhowe@blueyonder.co.uk",
            "sender_contact": null,
            "sender_business_name": null,
            "sender_address_line1": null,
            "sender_address_line2": null,
            "sender_address_line3": null,
            "sender_city": null,
            "sender_county": null,
            "sender_post_code": null,
            "sender_country_iso": "GB",
            "sender_email": null,
            "sender_telephone": null,
            "sales_reference": null,
            "sales_price": "0.000",
            "customs_price": "1.000",
            "sales_order_id": null,
            "custom_identity_reference": null,
            "payment_reference": null,
            "delivery_reference": "JJD0002258212509047",
            "tracking_reference": null,
            "special_instruction": null,
            "neighbour_instruction": "copy from consignment 2007100360000006\ncopy from consignment 2007120360000002\ncopy from consignment 2007140360000001\ncopy from consignment 2007140360000002\ncopy from consignment 2007140360000005\ncopy from consignment 2007140360000008\ncopy from consignment",
            "temp_consignment_info_id": null,
            "is_urgent": "0",
            "is_forced_delivery_service": "0",
            "create_time": "2020-10-29 12:09:31",
            "finish_time": "2020-10-29 14:04:13",
            "arrive_time": null,
            "update_time": "2020-10-29 14:05:50",
            "status": "FINISHED",
            "stock_status": "ORI_AND_DES_STOCK_ENOUGH",
            "primary_keys": [
                "id"
            ],
            "delivery_service_special_type": "YODEL",
            "delivery_service_is_use_delivery_agent_account_address": "1",
            "delivery_service_is_allow_urgent_consignment": "1",
            "delivery_service_is_hide_delivery_reference_to_consignment": "0",
            "delivery_service_internal_special_type": "YODEL",
            "consignment_delivery_agent-net17track_code": "ZZ",
            "country_name": "UNITED KINGDOM",
            "currency_code": "CNY",
            "consignment_feedback-status": null,
            "consignment_feedback-note": null
        },
        {
            "commodity_code": null,
            "total_price_customs_export": null,
            "name_customs": null,
            "total_quantity": null,
            "weight": null,
            "price": null,
            "price_customs_export": null,
            "period": null,
            "type": "LOCAL",
            "total": null,
            "external_code": null,
            "external_code1": null,
            "external_code2": null,
            "max_length": null,
            "max_width": null,
            "max_depth": null,
            "handling_fee_first_item": null,
            "handling_fee_other_item": null,
            "handling_fee_first_product": null,
            "handling_fee_other_product": null,
            "handling_fee": null,
            "handling_fee_urgent_consignment": null,
            "handling_fee_limit": null,
            "delivery_fee": null,
            "delivery_fee_type": null,
            "return_consignment_id": null,
            "return_consignment_action_type": null,
            "return_consignment_action_name": null,
            "quantity": null,
            "battery_type_name_list": null,
            "battery_type_id_list": null,
            "delivery_service_name": "Yodel Tracked（特惠）",
            "sku_count": null,
            "product_company_ref": null,
            "id": 2010290360000090,
            "company_id": 36,
            "client_id": 47,
            "warehouse_id": 80,
            "consignment_product_quantity": "1",
            "consignment_product_reference": "2989068",
            "delivery_service_id": 5867,
            "delivery_service_id_internal": 5867,
            "delivery_package_size_id": 617,
            "total_price": "0.00",
            "total_delivery_fee": "0.00",
            "total_handling_fee": "2.00",
            "length": "0.00",
            "width": "0.00",
            "depth": "0.00",
            "total_weight": 2000,
            "total_volume": "8000.00",
            "total_volume_weight": 1,
            "total_fee_weight": 2000,
            "guarantee_percentage": "0.00",
            "contact": "Heather Howe",
            "business_name": null,
            "address_line1": "3 Clun Close",
            "address_line2": null,
            "address_line3": null,
            "city": "Telford",
            "county": "Shropshire",
            "post_code": "tf13hx",
            "country_iso": "GB",
            "telephone": "01952400359",
            "email": "heatherhowe@blueyonder.co.uk",
            "sender_contact": null,
            "sender_business_name": null,
            "sender_address_line1": null,
            "sender_address_line2": null,
            "sender_address_line3": null,
            "sender_city": null,
            "sender_county": null,
            "sender_post_code": null,
            "sender_country_iso": "GB",
            "sender_email": null,
            "sender_telephone": null,
            "sales_reference": null,
            "sales_price": "0.000",
            "customs_price": "1.000",
            "sales_order_id": null,
            "custom_identity_reference": null,
            "payment_reference": null,
            "delivery_reference": "JJD0002258212509048",
            "tracking_reference": null,
            "special_instruction": null,
            "neighbour_instruction": "copy from consignment 2007100360000006\ncopy from consignment 2007120360000002\ncopy from consignment 2007140360000001\ncopy from consignment 2007140360000002\ncopy from consignment 2007140360000005\ncopy from consignment 2007140360000008\ncopy from consignment",
            "temp_consignment_info_id": null,
            "is_urgent": "0",
            "is_forced_delivery_service": "0",
            "create_time": "2020-10-29 12:10:23",
            "finish_time": "2020-10-29 14:04:13",
            "arrive_time": null,
            "update_time": "2020-10-29 14:05:50",
            "status": "FINISHED",
            "stock_status": "ORI_AND_DES_STOCK_ENOUGH",
            "primary_keys": [
                "id"
            ],
            "delivery_service_special_type": "YODEL",
            "delivery_service_is_use_delivery_agent_account_address": "1",
            "delivery_service_is_allow_urgent_consignment": "1",
            "delivery_service_is_hide_delivery_reference_to_consignment": "0",
            "delivery_service_internal_special_type": "YODEL",
            "consignment_delivery_agent-net17track_code": "ZZ",
            "country_name": "UNITED KINGDOM",
            "currency_code": "CNY",
            "consignment_feedback-status": null,
            "consignment_feedback-note": null
        }
    ],
    "success": true,
    "moduleName": "client"
}

主要返回参数说明：

...

delivery_service_name

...

邮递服务名称

...

VARCHAR

...

id

...

contact

...

address_line1

...

地址行1

...

VARCHAR(100)

...

address_line2

...

地址行2

...

VARCHAR(100)

...

address_line3

...

地址行3

...

VARCHAR(100)

...

city

...

城市

...

VARCHAR(50)

...

county

...

省/郡

...

VARCHAR(50)

...

post_code

...

邮编

...

VARCHAR(10)

...

country_iso

...

国家

...

CHAR(2)

...

telephone

...

电话

...

VARCHAR(50)

...

email

...

电子邮件

...

VARCHAR(255)

...

sales_reference

...

销售跟踪号

...

create_time

...

创建订单的时间

...

TIMESTAMP

...

update_time

...

订单最后更新时间

...

TIMESTAMP

...

type

...

订单类型

...

ENUM('LOCAL','DIRECT','RETURN','AGENT_DIRECT')

...

本地订单的状态流转是：准备中->待处理->待拣货->拣货中->处理中->已完成（->审核中，如缺货等原因仓库无法出单则会改到审核中状态）

Consignment的退货订单(RETURN)状态包含：

...

退货订单的状态流转是：准备中->已收货->待处理->处理中->审核中->已完成

Consignment的代理专线订单(AGENT_DIRECT)状态包含：

...

代理专线订单的状态流转是：准备中->待处理->已出地址贴→已完成

创建普通订单的样例:

Code Block

language	bash
linenumbers	true

# api_key和company_id和提交数据中的delivery_service_id需要替换成实际数据
curl -X POST \
  https://test.birdsystem.com/client/consignment \
  -H 'api_key: 248ccb90dff2b99465b54c113765360c' \
  -H 'company_id: 36' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'contact=Norman%20Drury&address_line1=3%2C%20Northam%20Close&address_line2=Marshside&city=Southport&county=Merseyside&post_code=PR9%209GA&country_iso=GB&telephone=01704%20226830&sales_reference=2&type=LOCAL&delivery_service_id=2662'

请注意，订单的邮递服务ID，是和你当前所在的仓库和联系人国家相关的，如果在提交的时候发生邮递服务的错误，请优先检查这部分的问题。

创建退货订单的样例:

...

language	bash
linenumbers	true

...

Include Page

	订单查询 (通用)
	订单查询 (通用)

Include Page

	说明-订单状态
	说明-订单状态

Versions Compared

Old Version 32

New Version Current

Key

接口说明：

查询订单列表时可使用的一些过滤字段:

请求示例：

主要返回参数说明：