Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 62 Next »

创建订单

地址: 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_order_id
销售订单号选填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)

special_instruction
发件人地址备注选填VARCHAR(255)

type

订单类型选填'AGENT_DIRECT'

products

产品

必填

包含 
字段详情查看产品接口

id /client_sku/reference 和quantity的json对象例如:
请求参数

     
   "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"
           }
        ]
parcel_pieces多包裹信息选填(如果仅一个包裹时可不用填)

数据结构如下:

[

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

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

]

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



"success": true,
    "data": [
        {
            "id": 2012010010000334,
            "company_id": 1,
            "client_id": 4790,
            "warehouse_id": null,
            "consignment_product_quantity": "1",
            "consignment_product_reference": "3apple29",
            "delivery_service_id": 5947,
            "delivery_service_id_internal": 5947,
            "delivery_package_size_id": 1,
            "total_price": "0.00",
            "total_delivery_fee": "0.00",
            "total_handling_fee": "0.10",
            "length": "0.00",
            "width": "0.00",
            "depth": "0.00",
            "total_weight": "300.00",
            "total_volume": "0.00",
            "total_volume_weight": "0.0000",
            "total_fee_weight": "300.0000",
            "guarantee_percentage": "0.00",
            "contact": "Norman Drury",
            "business_name": null,
            "address_line1": "3, Northam Close",
            "address_line2": "Marshside",
            "address_line3": null,
            "city": "Southport",
            "county": "Merseyside",
            "post_code": "PR9 9GA",
            "country_iso": "GB",
            "telephone": "01704 226830",
            "email": "mm",
            "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": "3.000",
            "custom_identity_reference": null,
            "sales_order_id": "110222319566-0",
            "payment_reference": null,
            "delivery_reference": null,
            "tracking_reference": null,
            "special_instruction": "mm",
            "neighbour_instruction": null,
            "temp_consignment_info_id": null,
            "is_urgent": "0",
            "is_forced_delivery_service": "0",
            "create_time": "2020-12-01 15:16:23",
            "finish_time": "2020-12-01 15:16:24",
            "arrive_time": null,
            "update_time": "2020-12-01 15:16:24",
            "type": "AGENT_DIRECT",
            "status": "FINISHED",
            "stock_status": "ONLY_ORI_STOCK_ENOUGH",
            "is_hide_delivery_reference_to_consignment": "0",
            "delivery_service_is_signature": "0",
            "delivery_service_is_tracking": "1"
        }
    ],
    "moduleName": "client"
}

line: 创建失败的时候, 会告知是哪一个line出错.

返回

{
    "success": true,
    "data": [
        {
            "id": 2001210360000027,
            "company_id": 36,
            "client_id": 47,
            "warehouse_id": null,
            "consignment_product_quantity": "2",
            "consignment_product_reference": "3apple29,4apple29",
            "delivery_service_id": 5198,
            "delivery_service_id_internal": 5198,
            "delivery_package_size_id": 877,
            "total_price": "0.00",
            "total_delivery_fee": "9.00",
            "total_handling_fee": "0.00",
            "length": "0.00",
            "width": "0.00",
            "depth": "0.00",
            "total_weight": "600.00",
            "total_volume": "0.00",
            "total_volume_weight": "0.0000",
            "guarantee_percentage": "0.00",
            "contact": "Rochelle Kerr",
            "business_name": null,
            "address_line1": "23 Portelet Court",
            "address_line2": null,
            "address_line3": null,
            "city": "London",
            "county": "London",
            "post_code": "N1 5TL",
            "country_iso": "GB",
            "telephone": "07983-467763-467763",
            "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": null,
            "sales_price": "0.000",
            "customs_price": "6.000",
            "custom_identity_reference": "224SF242321",
            "sales_order_id": null,
            "payment_reference": null,
            "delivery_reference": "0B043873700001DFE9790",
            "tracking_reference": null,
            "special_instruction": null,
            "neighbour_instruction": null,
            "temp_consignment_info_id": null,
            "is_urgent": "0",
            "is_forced_delivery_service": "0",
            "create_time": "2020-01-21 18:22:57",
            "finish_time": null,
            "arrive_time": null,
            "update_time": "2020-01-21 18:22:57",
            "type": "AGENT_DIRECT",
            "status": "ADDRESS_LABEL_PRINTED",
            "stock_status": "ONLY_ORI_STOCK_ENOUGH",
            "is_hide_delivery_reference_to_consignment": "0"
        }
    ],
    "moduleName": "client"
}

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

接口返回示例

接口返回示例
{
    "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

接口返回示例:

请求返回结果
{
    "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"
}

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


  • No labels