Versions Compared

Key

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

1.

...

1、查询邮递服务

1.1.1接口接口说明

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


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


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

1.1.2请求参数

...


返回字段字段类型说明
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

Code Block
languagexml
firstline查询邮递服务接口
titleURL:http://test.birdsystem.com/client/delivery-service?id=5217
linenumberstrue
collapsetrue
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

Code Block
languagexml
firstlinehttp://test.birdsystem.com/client/product-customs-property
title查询产品属性
linenumberstrue
collapsetrue
company_id:{{bs.default_company_id}}
api_key:{{bs.default_api_key}}
id:1

接口返回示例:

Code Block
languagexml
title请求返回结果
linenumberstrue
collapsetrue
{
    "total": 1,
    "data": [
        {
            "id": 1,
            "name": "内置锂离子电池",
            "value_type": "BOOL",
            "default_value": "sdsf",
            "symbol": "#",
            "is_separate_picking_list": "1",
            "is_separate_warehouse_transfer": "1",
            "consignment_priority": "2",
            "picking_list_group": "HK",
            "create_time": "2015-07-07 10:12:52",
            "special_type": "BETTERY",
            "primary_keys": [
                "id"
            ]
        }
    ],
    "success": true,
    "moduleName": "client"
}

查询参数为空或输入无效参数,则默认查询所有产品属性





创建订单

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

...