基本概念

名称

接口

说明

名称

接口

说明

客户

/Client

一个客户及系统内的一个账号,对第三方平台而言所有的操作都是围绕该账户下的相关信息(如产品、订单、账单等)进行操作的。

客户用户

/Client-User

一个客户账号下可以有一个或多个客户用户,每个用户均有自己的用户名、密码及API KEY用来做网页界面登陆或者API交互。客户可以自主设置每个用户的相关权限组。

公司

客户端不提供公司操作接口

公司及俗称的"仓",例如鸟系统现在有英国仓、美国仓、德国仓等。
在鸟系统下一个客户可以对应一个或多个公司,具体设置请联系鸟系统客服经理。每个公司下均有不同的币种结算。在所有的API调用过程中均需给出公司的ID作为标示,所有的公司列表可以调用/public/company-list接口来查询

产品

/Product

每个客户在不同公司下所有的产品种类(SKU)均自动共享,不过产品库存数不同

订单

/Consignment

订单在用户界面上分为"本地订单","专线订单",“代理专线订单”和"退货订单", "代理订单" 和 "批量订单" 五种。基本接口均为 /Consignment 。 通过订单下地type类别来识别,分别相对应的是LOCAL,DIRECT, AGENT_DIRECT,RETURN, AGENT 和 BATCH。

Local Consignment本地订单为最基本的仓储配送服务类型,需要在当前仓库先有库存后才可下单,否则系统会提示报错。

DIRECT Consignment专线订单为客户自主发货服务,系统中需产品备案,无需有库存,但是需要通过鸟系统的订单信息来打印相应地址贴。

AGENT_DIRECT Consignment代理专线订单为客户自主发货服务,系统中无需产品备案可直接下单,也需要通过鸟系统的订单信息来打印相应地址贴。

Return Consignment退货订单,当客户需要退货管理服务时在此下单。

AGENT_DIRECT Consignment 代理订单主要用作帮助客户记录其他非鸟系统提供得邮递服务的订单记账功能。 目前我们仅支持DHL的订单汇总文件。

Batch Consignment批量订单与专线订单类似,不同之处在于批量订单是按照整体重量收费的

批量订单

/Temp-Consignment-Info

Consignment一次只可手工添加一次,为了方便客户使用,批量订单允许批量将从eBay和Amazon平台下载的订单记录批量上传,通过触发/Temp-Consignment-Info/Convert-Into-Consignment接口批量转换为相应地订单。

邮递服务

/Delivery-Service

每个公司下均有依当地实情的不同邮递服务,客户在下订单的时候必须先指定所需服务,每个服务都有对应的type

头程物流计划

/Warehouse-Dispatch-Freight

每个公司下均有依当地事情的不同的头程物流计划,客户在下单头程物流发货单的时候,将会参照头程物流计划中的信息做出计划安排(实际发货情况以仓库为准)

客户头程物流发货单

/Client-Dispatch

客户的头程物流发货单

*上述接口均基于 http://test.birdsystem.com/client 前缀,其中client表示的是客户端操作,所有第三方平台操作均需在此前缀下进行。

例如:调用客户接口    http://test.birdsystem.com/client/Client

           调用创建订单接口   http://test.birdsystem.com/client/Consignment

注意:接口调用区分大小写

wiki文档中提到的接口, 可以在我们提供postman用例文件2020-01-10-鸟系统对接API.postman_collection.json) 中找到案例, 如下图.

(用法: 下载postman工具, 导入上面链接提供的json文件 , 如需修改api地址或company_id或api_key, 在postman中右击api根目录, 点击编辑, 切换到variables目录来修改, 如下图:)