Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of Contents |
---|
接口说明
用于批量创建一个或者多个本地/专线订单,并将订单自动改到待处理状态,交由仓库处理.
接口格式
URL
Table of Contents |
---|
接口说明
用于批量创建一个或者多个本地/专线订单,并将订单自动改到待处理状态,交由仓库处理.
接口格式
URL | https://<系统域名>/client/Consignment/Post-Pending-Consignment-With-Products-Json | ||
---|---|---|---|
接口功能 | 批量创建本地/专线订单 | 订单类型 | 本地订单/专线订单 |
支持格式支持参数格式 | JSON | 开发人员 | |
请求方式 | POST | 发布日期 |
接口参数
参数 | 类型 | 必填 | 说明 | 是否对接字段/取值内容 | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
is_urgent | BOOL |
| 是否紧急订单,取值0或者1, 默认为0 | 按客户填的传 | |||||||||||||||||||||||||
delivery_service_id / delivery_service_name | INT/STRING |
| 邮递服务ID,邮递服务ID或者邮递服务名称,从 邮递服务查询 获取可用邮递服务列表,只能填写订单类型为LOCAL/DIRECT的邮递服务 | 按客户填的传 | 获取邮递服务列表,只能填写订单类型为LOCAL/DIRECT的服务, 且要与报文中的type字段对应. | 按客户填的传 | |||||||||||||||||||||||
consignment_packing | STRING |
| 出库包装方式. 本地订单需要额外打包时,填此项,由仓库根据此字段进行操作和收费 | CARTON 纸箱 PLASTIC_BAG 塑料袋 | |||||||||||||||||||||||||
sales_reference | STRING |
| 销售跟踪号 | 按用户填的传/或REP系统单号按用户填的传或REP系统单号 | |||||||||||||||||||||||||
sales_order_id | STRING |
| 销售订单号 | 按用户填的传/或REP系统单号按用户填的传或ERP系统单号 | |||||||||||||||||||||||||
custom_identity_reference | STRING |
| 自定义唯一跟踪号 (如果填写了,会进行检测,同一种类型同一站点下的订单,6个月内不能有重复的标识, 如果填写了,会进行重复检测,同一订单种类同一站点下的订单,6个月内不能有重复的标识, 重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}) | 按用户填的传/或REP系统单号(birdsystem会根据改字段判断订单是否重复)按用户填的传或REP系统单号(birdsystem会根据改字段判断订单是否重复) | |||||||||||||||||||||||||
contact | STRING |
| 收件联系人 | 按用户填的传 | |||||||||||||||||||||||||
business_name | STRING |
| 公司 | 按用户填的传 | |||||||||||||||||||||||||
address_line1 | STRING |
| 地址行1 | 按用户填的传 | |||||||||||||||||||||||||
address_line2 | STRING |
| 地址行2 | 按用户填的传 | |||||||||||||||||||||||||
city | STRING |
| 城市 | 按用户填的传 | |||||||||||||||||||||||||
county | STRING |
| 省/郡 | 按用户填的传 | |||||||||||||||||||||||||
post_code | STRING |
| 邮编 | 按用户填的传 | |||||||||||||||||||||||||
country_iso | STRING |
| 国家, 填2位ISO国家代码, 不同邮递服务能发的国家不同. | 按用户填的传 | |||||||||||||||||||||||||
telephone | STRING |
| 电话 | 按用户填的传 | |||||||||||||||||||||||||
STRING |
| 电子邮箱 | 按用户填的传 | ||||||||||||||||||||||||||
special_instruction | STRING |
| 备注1 | 按用户填的传 | |||||||||||||||||||||||||
neighbour_instruction | STRING |
| 备注2 | 按用户填的传 | |||||||||||||||||||||||||
type | STRING |
| 订单类型 取值LOCAL或DIRECT本地订单传 LOCAL | 按用户填的传 | |||||||||||||||||||||||||
products | JSON ARRAY |
产品 "client_sku":"IP-XX3355", "quantity":5,
| 产品详细信息数组, 其详细见 产品字段描述
{ "id
"ebay_item_no":"0002yuhao"} ] 按客户填的传 /eBay订单交易号
/eBay产品ID)eBay的订单需要传(选填) (sales_price
| 按用户填的传 | |||||||||||||||||||||||||
parcel_pieces | JSON ARRAY |
| 多包裹信息,如果仅一个包裹时可不用填. 一票多件的多包裹信息,如果仅一个包裹时可不用填.
备注:重量为克(g),长度为毫米(mm)其中, 重量单位为克(g),尺寸单位为毫米(mm) | 按用户填的传 | |||||||||||||||||||||||||
payment_reference | STRING |
| 付款凭证 | 按用户填的传 | |||||||||||||||||||||||||
omp_name | STRING |
| 销售平台名称 | 按用户填的传
| , 必须是英文 【royal mail,yodel 出口必填】 常见的平台代码如下:
| 按用户填的传 | |||||||||||||||||||||||
omp_vat_number | STRING |
| 销售平台VAT号 , 【yodel 出口必填】 英国发往非英国且公司不为空("business_name"字段)的DPD订单 要求必填字段)的DPD订单必填 | 按用户填的传 | |||||||||||||||||||||||||
shipper_eori | STRING |
| 客人的EORI号, 必须是国家代码+12位数字,例如:GB000000777888 ,必须提前在鸟系统备案,详询客服,必须提前在鸟系统备案VAT,详询客服. 参考接口: 获取VAT账号 ,【royal mail,yodel 出口必填】 英国发往EU必填 英国发往非英国的DPD服务必填 | 按用户填的传 | |||||||||||||||||||||||||
reason_for_export | STRING |
| 出口原因, 取值【Sale取值【SALE:销售; ReturnReplacementRETURN REPLACEMENT:退换; GiftGIFT:礼物】 【dpd 出口必填】 | 一般传:SALE | |||||||||||||||||||||||||
content_type | STRING |
| 包裹类型, 取值【Gift 礼物;Documents 文件和 Other 其他】一般传:Other 取值【GIFT:礼物; DOCUMENTS:文件; OTHER:其他】 【royalmail 出口必填】 | 一般传:OTHER | |||||||||||||||||||||||||
sender_contact | STRING |
| 发件人 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||
sender_address_line1 | STRING |
| 发件人地址行1 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||
sender_address_line2 | STRING |
| 发件人地址行2 | 按客户填的传 | |||||||||||||||||||||||||
sender_city | STRING |
| 发件人城市 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||
sender_county | STRING |
| 发件人省/郡 | 按客户填的传 | |||||||||||||||||||||||||
sender_post_code | STRING |
| 发件人邮编 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||
sender_country_iso | STRING |
| 发件人国家 (DPD服务必填), 填2位ISO国家代码(DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||
sender_email | STRING |
| 发件人电子邮箱 | 按客户填的传 | |||||||||||||||||||||||||
sender_telephone | STRING |
| 发件人电话 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||
ioss_vat_number | STRING |
| IOSS号, 订单发往欧盟国家时必填填写客户实际IOSS号 | 按客户填的传 | |||||||||||||||||||||||||
receiver_eori | STRING |
| 收件人EORI 英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填name“字段)的DPD订单必填 | 按客户填的传 | |||||||||||||||||||||||||
receiver_pid_number | STRING |
| 收件人个人证件号 英国发往挪威、西班牙、意大利的DPD订单 要求必填 英国发往挪威、西班牙、意大利的DPD订单必填 | 按客户填的传 | |||||||||||||||||||||||||
is_compensation_for_delay | BOOL |
| 是否需要晚必赔服务(仅支持部分服务,偏远地区除外), 取值0或者1, 默认为0 |
是否需要晚必赔服务(仅支持部分服务,偏远地区除外), 取值0或者1, 默认为0 | 按客户填的传 |
Anchor | ||||
---|---|---|---|---|
|
参数 | 类型 | 必填 | 说明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id/client_sku/reference | INT/STRING |
| 产品id/客户SKU/产品reference client_sku有另一个同义词是client_ref产品reference是根据批量订单产品字段的设置来识别是id还是客户SKU 产品reference是由 “设置”->”账户” 中的 批量订单设置来决定字段值是产品id还是客户SKU Image Added也支持定向共享产品.其格式:
| ||||||||
quantity | INT |
| 数量此SKU的数量 | ||||||||
ebay_transaction_id | STRING |
| eBay订单交易号 | ||||||||
ebay_item_no | STRING |
| eBay产品ID | ||||||||
sales_price | FLOAT(10,2) |
| 销售价格此SKU的销售单价,两位小数,单位为美元(USD) |
接口示例
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
温馨提示: 请求
返回
data是创建成功的订单号和跟踪号的键值对 json对象 异常返回必填项
|