Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

订单查询:接口描述

URL

https://

test.birdsystem.com

<系统域名>/client/consignment

1

接口功能

查询订单

2

支持格式

JSON

开发人员

数据已丢失

3

请求方式

POST/

GET

发布日期

数据已丢失

...

参数描述

字段名

说明

类型

1

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' 这些值中的任意一个

2

type

订单类型

字符串,只能是 'LOCAL','DIRECT','RETURN','AGENT_DIRECT','CLIENT_DIRECT' 这些值中的任意一个

3

id

订单id

BINGINT(16)

4

consignment_product_reference

产品id

INT(10)

5

sales_reference

销售跟踪号

字符串

6

delivery_reference

运输跟踪号

字符串

7

post_code

邮编

字符串

8

contact

收件人

字符串

...

9

sales_reference

销售跟踪号

INT

10

sales_order_id

销售订单号

INT

11

custom_identity_reference

自定义唯一标识

INT

(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

Expand
title(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

使用接口调试工具postman
请求描述
Http请求格式:

Code Block
languagejson
GET /client/consignment/ HTTP/1.1
Host: {{Bird_URL}}
Headres:
  api_key: {{api_key}}
  company_id: {{company_id}}
  Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254
Body
  raw
{
    "type": "AGENT_DIRECT",
    "page": 1,
    "start": 0,
    "limit": 50,
    "filter": [{"type":"numeric","comparison":"gt","value":"","field":"id"},{"type":"numeric","comparison":"lt","value":"","field":"id"},{"type":"date","comparison":"gt","value":"2021-05-17","field":"update_time"},{"type":"list","value":["PENDING","ADDRESS_LABEL_PRINTED"],"field":"status"}],
    "id":2105240360032744
}

返回结果:

Code Block
{
    "total": 1,
    "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": "AGENT_DIRECT",
            "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": "D 中德跟踪Hermes",
            "sku_count": null,
            "product_company_ref": null,
            "id": 2105240360032744,
            "company_id": 36,
            "client_id": 4790,
            "warehouse_id": null,
            "consignment_product_quantity": "0",
            "consignment_product_reference": "3apple297777777,3apple2988888,3apple299999999",
            "delivery_service_id": 5904,
            "delivery_service_id_internal": null,
            "delivery_package_size_id": 617,
            "total_price": "0.00",
            "total_sales_price": null,
            "total_delivery_fee": "0.00",
            "total_handling_fee": "0.00",
            "length": "0.00",
            "width": "0.00",
            "depth": "0.00",
            "total_weight": "900.00",
            "total_volume": "0.00",
            "total_volume_weight": "0.0000",
            "total_fee_weight": "900.0000",
            "guarantee_percentage": "0.00",
            "contact": "bird",
            "business_name": "Feiniao",
            "address_line1": "bantian guojizhongxin",
            "address_line2": "D dong 607/610",
            "address_line3": null,
            "city": "guangdong",
            "county": "shenzheng",
            "post_code": "888888",
            "country_iso": "GB",
            "telephone": null,
            "email": null,
            "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": null,
            "sender_email": null,
            "sender_telephone": null,
            "sales_reference": "2",
            "sales_price": "0.000",
            "customs_price": "7.020",
            "sales_order_id": null,
            "custom_identity_reference": null,
            "payment_reference": null,
            "delivery_reference": null,
            "tracking_reference": "BSLAA1052400003YQ",
            "special_instruction": null,
            "neighbour_instruction": null,
            "omp_name": null,
            "omp_vat_number": null,
            "shipper_eori": null,
            "temp_consignment_info_id": null,
            "is_urgent": "0",
            "is_forced_delivery_service": "0",
            "create_time": "2021-05-24 11:17:54",
            "finish_time": null,
            "arrive_time": null,
            "update_time": "2021-05-24 11:53:18",
            "status": "PENDING",
            "stock_status": "ONLY_ORI_STOCK_ENOUGH",
            "reason_for_export": null,
            "content_type": null,
            "primary_keys": [
                "id"
            ],
            "is_light_product": "0",
            "delivery_service_special_type": null,
            "delivery_service_is_use_delivery_agent_account_address": "1",
            "delivery_service_is_allow_urgent_consignment": "1",
            "delivery_service_is_hide_delivery_reference_to_consignment": null,
            "delivery_service_internal_special_type": null,
            "consignment_delivery_agent-net17track_code": "AA",
            "country_name": "UNITED KINGDOM",
            "currency_code": "CNY",
            "consignment_feedback-status": null,
            "consignment_feedback-note": null
        }
    ],
    "success": true,
    "moduleName": "client"
}