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请求参数


参数必选类型说明
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接口示例
1.2.1接口请求示例
URL:http://test.birdsystem.com/client/delivery-service?id=5217

Code Block
languagexml
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
titlehttp://test.birdsystem.com/client/delivery-service?id=5217接口返回示例
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"
}

...

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

参数


is_urgent

是否是紧急订单


TINYINT(1)

delivery_service_id

邮递服务ID

必填

INT(4)

sales_reference销售跟踪号
VARCHAR(50)

sales_reference

销售跟踪号


VARCHAR(50)


custom_identity_reference


自定义惟一标识

(注: 如果填写了,会进行检测,同一种类型同一站点下的订单,6个月内不能有重复的标识)

重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}


VARCHAR(50)

contact

联系人

必填

VARCHAR(100)

business_name

公司


VARCHAR(255)

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)

type

订单类型
'AGENT_DIRECT'

products

产品

必填

包含 

id /client_sku/reference 和quantity的json对象例如:

[
 {"client_sku":”IP-XX3355”,"quantity":5},
 {"id":2,"quantity":4},
{"reference":2,"quantity":4}

]

id :飞鸟产品系统id,飞鸟系统自动生成的。

client_sku :主要是给那些有自己的SKU体系的客户用的。如果传了值就是你们传的,如果没传,系统会自动根据 client_id-id的格式生成。

client_ref:  id和sku都可以填,但部分接口不适用,post-pending不适用client_ref参数。


reference是基于客户对批量订单产品字段的设置, 自动识别为ID或者SKU.

对于代理专线订单, 需要传如下格式的产品 (每个字段均是必填):

[
 {"name":”IP-XX3355”,"name_cn":"中文产品名","quantity":5,"weight":5,"price":5},

]

parcel_pieces多包裹信息可选(如果仅一个包裹时可不用填)

数据结构如下:

[

{"weight":500, "length":25, "width":20, "depth":15, "description":"table"},

{"weight":400, "length":22, "width":18, "depth":13, "description":"chair"},

]

备注:重量为克(g),长度为毫米(mm)


ebay_transaction_ideBay订单交易号选填VARCHAR(50)
ebay_item_noeBay产品ID选填VARCHAR(50)


参数 说明

product_customs_property: 产品属性性可以用名称,也可以用ID,获取途径如上。 [必填]

...