Page Comparison

邮递服务查询：接口描述此接口用于获取邮递服务即渠道接口简介

url	http://

test.birdsystem.com

接口功能
<系统域名>/client/delivery-service

获取邮递服务

支持格式
邮递服务信息查询. 创建出库单时需要指定物流渠道，即delivery_service_id参数. 是从这里获取

JSON

请求方式
json	开发人员

GET

发布日期

参数描述

（不加任何参数查到的就是所有的服务）

参数

说明

类型

id

系统ID

get	发布日期

请求参数描述

参数名	字段类型	说明
consignment_type	ENUM('LOCAL','DIRECT','RETURN','AGENT_DIRECT')	按订单类型查询邮递服务
status		按状态来查询邮递服务
is_tracking	数字，0或者1	按是否跟踪来查询邮递服务
is_signature	数字，0或者1	按是否签名服务来查询邮递服务
is_express	数字，0或者1	按是否快递来查询邮递服务

返回Json描述

参数	字段类型	说明
id	INT(10)	系统ID
company_id	INT(10)	站点ID, 默认只返回当前登录的company_id下的邮递服务
name	VARCHAR	名称

VARCHAR（无效）

locale_name	VARCHAR	本地名称, 一般是另一个比较好记的邮递服务名称
consignment_type

订单类型

	ENUM('LOCAL','DIRECT','RETURN','AGENT_DIRECT')	订单类型
status

状态

	ENUM('ACTIVE','DELETED','DORMANT')	邮递服务的状态，只有ACTIVE状态的邮递服务才能使用。
is_tracking	数字，0或者1	是否跟踪服务

数字，0或者1（无效）


is_signature	数字，0或者1	是否签名服务

数字，0或者1（无效）

is_international	数字，0或者1	是否国际服务
is_customs_required	数字，0或者1	是否要求报关
is_express	数字，0或者1	是否快递

数字，0或者1（无效）

is_hide_delivery_reference_to_consignment

数字，0代表需要，1代表该渠道没有运输跟踪号

是否需要获取运输跟踪号

数字，0代表需要，1代表该渠道没有运输跟踪号（无效）

请求描述

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

Expand

title	（以下为折叠内容，签署合同时以下信息无需参考，仅供第三方对接参考）

使用接口调试工具postman
请求描述：
温馨提示：

1、只有邮递服务状态为正常时，该服务才能正常下单。（举例：&status=ACTIVE）
Http请求格式：

Code Block

language	py

GET /client/delivery-service/?status=ACTIVE HTTP/1.1
Host: {{Bird_URL}}
Headres:
  api_key: {{api_key}}
  company_id: {{company_id}}
  Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254
Body
  raw
    [{"id"=6306}]

返回结果：

Code Block

language	py

{
    "total": 1,
    "data": [
        {
            "id": 6306,
            "company_id": 36,
            "restrict_max_length_contact": "0",
            "restrict_max_length_address_line1": "0",
            "restrict_max_length_address_line2": "0",
            "restrict_max_length_address_line3": "0",
            "restrict_max_length_post_code": "0",
            "restrict_regex_post_code": null,
            "restrict_regex_telephone": null,
            "name": "AD Royal Mail Tracked 48",
            "locale_name": "",
            "is_signature": "0",
            "is_tracking": "1",
            "is_express": "0",
            "is_international": "0",
            "is_customs_required": "1",
            "is_check_post_code": "0",
            "is_check_telephone": "0",
            "is_allow_urgent_consignment": "1",
            "is_hide_delivery_reference_to_consignment": "0",
            "special_type": "BIRDSYSTEM",
            "consignment_type": "AGENT_DIRECT",
            "consignment_notice_enable": "0",
            "consignment_notice": "",
            "status": "ACTIVE"
        }
    ],
    "success": true,
    "moduleName": "client"
}

Versions Compared

Old Version 11

New Version Current

Key