Versions Compared

Key

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

创建订单

地址: POST http://test.birdsystem.com/client/consignment/Post-Pending-Consignment-With-Products-Json

...

attachment-url:产品图片URL,传送图片链接供飞鸟质检审核产品(只能传网上的图片,不能传本地的)

returnLabel:直接对接获取面单参数标识 ,returnLable =1 时可以直接获取面单,=0 不直接获取面单。(只适用于下一个订单的情况,批量创建多个订单的时候不起作用)

接口:特殊接口:http://test.birdsystem.com/client/Consignment/post-Pending-Consignment-With-Products-Json?returnLabel=1&company_id=36&api_key=a0366845436b4775e6c5caef5ebc0d0d

returnLabel:直接对接获取面单参数标识 ,returnLable =1 时可以直接获取面单,=0 不直接获取面单。(只适用于下一个订单的情况,批量创建多个订单的时候不起作用)

Code Block
[
  {
    "delivery_service_id": "5198",
       "type":"AGENT_DIRECT",
    "business_name": "",
    "contact": "Rochelle Kerr",
    "address_line1": "23 Portelet Court",
    "city": "London",
    "county": "London",
    "post_code": "N1 5TL",
    "country_iso": "GB",
    "telephone": "07983-467763-467763",
    "custom_identity_reference":"224SF242321",
    "products": [
      {
        "product_name": "3apple29",
        "product_name_cn":"3苹果29",
        "brand":"asd品牌",
        "client_ref":"a4624",
        "price_customs_export": "3",
        "sales_price":"10",
        "weight": "300",
        "quantity": "1",
        "product_customs_property":["普货"],
        "attachment-url":"http://www.qqma.com/imgpic2/cpimagenew/2018/4/5/6e1de60ce43d4bf4b9671d7661024e7a.jpg"
      },
       {
        "product_name": "4apple29",
        "product_name_cn":"4苹果29",
        "brand":"asd品牌",
        "client_ref":"a5456",
        "price_customs_export": "3",
        "sales_price":"10",
        "weight": "300",
        "quantity": "1",
        "product_customs_property":["内置锂离子电池"],
        "attachment-url":"http://www.qqma.com/imgpic2/cpimagenew/2018/4/5/6e1de60ce43d4bf4b9671d7661024e7a.jpg"
      }
    ]
  }
]

...

data是创建成功的订单号和跟踪号的键值对 json对象

1.1、查询邮递服务

1.1.1接口接口说明

1urlhttp://test.birdsystem.com/client/delivery-service?consignment_type=LOCAL


2接口功能查询邮递服务信息以及邮递服务限制条件


3支持格式URL开发人员
4请求方式GET发布日期

1.1.2请求参数


参数必选类型说明
1id选填int(4)邮递服务ID
2special_type选填string(50)邮递服务特殊类别
3consignment_type选填string(50)邮递服务所属订单类型
4status选填string(50)邮递服务所属状态

1.1.3返回字段

1表示为是,0表示为否


返回字段字段类型说明
1idint邮递服务ID
2company_idint站点ID
3restrict_max_length_contactint联系人最大长度
4restrict_max_length_address_line1int地址行1最大长度
5restrict_max_length_address_line2int地址行2最大长度
6restrict_max_length_address_line3int地址行3最大长度
7restrict_max_length_post_codeint邮编最大长度
8restrict_regex_post_codestring邮编正则表达式
9restrict_regex_telephonestring电话正则表达式
10namestring邮递服务名称
11locale_namestring本地名称(当地区域语言)
12is_signatureint(1或0)是否签名服务()
13
is_tracking
int(1或0)是否跟踪服务
14
is_express
int(1或0)是否为快递
15
is_international
int(1或0)是否为国际服务
16
is_customs_required
int(1或0)是否需要报关
17
is_check_post_code
int(1或0)是否检查邮编正确性
18
is_check_telephone
int(1或0)是否检查电话正确性
19
is_allow_urgent_consignment
int(1或0)是否允许设置紧急订单
20
is_hide_delivery_reference_to_consignment
int(1或0)是否隐藏订单运输跟踪号
21
special_type
string邮递服务特殊类别
22
consignment_type
string邮递服务所属订单类型
23
consignment_notice_enable
int(1或0)是否开启下单提示
24
consignment_notice
status下单提示
25
status
string邮递服务当前状态

1.2接口示例

接口请求示例
URL:http://test.birdsystem.com/client/delivery-service?id=5217

company_id:{{bs.default_company_id}}
api_key:{{bs.default_api_key}}
id:5217

接口返回示例

Code Block
languagexml
title接口返回示例
linenumberstrue
collapsetrue
{
    "total": 1,
    "data": [
        {
            "id": 5217,
            "company_id": 36,
            "restrict_max_length_contact": "20",
            "restrict_max_length_address_line1": "20",
            "restrict_max_length_address_line2": "35",
            "restrict_max_length_address_line3": "35",
            "restrict_max_length_post_code": "0",
            "restrict_regex_post_code": null,
            "restrict_regex_telephone": null,
            "name": "飞鸟小包",
            "locale_name": "",
            "is_signature": "0",
            "is_tracking": "0",
            "is_express": "0",
            "is_international": "0",
            "is_customs_required": "0",
            "is_check_post_code": "0",
            "is_check_telephone": "0",
            "is_allow_urgent_consignment": "1",
            "is_hide_delivery_reference_to_consignment": "0",
            "special_type": null,
            "consignment_type": "LOCAL",
            "consignment_notice_enable": "0",
            "consignment_notice": "",
            "status": "ACTIVE"
        }
    ],
    "success": true,
    "moduleName": "client"
}


2查询可用产品属性

2.1.1、接口

url
http://test.birdsystem.com/client/product-customs-property

接口功能
查询可用产品属性

支持格式JSON开发人员
请求方式GET发布时间


2.1.2、请求参数

参数必填类型说明
id选填int产品属性ID


2.1.3、返回字段

返回字段字段类型说明
idint产品属性ID
namestring产品属性名称
value_type
string产品属性种类
default_value
string产品属性默认值
symbol
string产品属性符号
is_separate_picking_list
int是否创建单独的拣货单
is_separate_warehouse_transfer

int

是否创建单独的调拨单
consignment_priority
int订单属性优先级
picking_list_group
string渠道属性分组
create_time
string创建时间
special_type
string特殊类别
primary_keys
string主键列名


2.2.1接口示例:

接口请求示例:
地址:http://test.birdsystem.com/client/product-customs-property

company_id:{{bs.default_company_id}}
api_key:{{bs.default_api_key}}
id:1

...