...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Name
...
* All End Points below are to be prefixed with http://test.birdsystem.co.uk/client, the '/client' part means it's for Client operations. All third party integrations are to operate under this name space. For example, the Client End Point is http://test.birdsystem.co.uk/client/Client , the Client User End Point is http://test.birdsystem.co.uk/client/Client-User. Please be aware that these end points are case-sensitive, incorrect case may result incorrect response from server.
Name | End Point | Note |
|---|---|---|
Client | /Client | One 'Client' is an account in the system, from the perspective of Integration, all operations (Product, Consignment, Statements, etc.) are based on the current account. |
Client User | /Client-User | There may be multiple 'Client Users' under one 'Client' account, each has their own Username, Password and API Key to login or communicate programmatically. Client and setup privilege of Client User by utilising Client Group |
Company | /Company (Not accessible by Client) | Company acts like 'Site'. There are multiple companies in BirdSystem, such as UK Site, US Site, Germany Site, etc. Each Client can be associated with one or more companies, as set by Customer Service Manage. Each Company is 公司及俗称的"仓"，例如鸟系统现在有英国仓、美国仓、德国仓等。 All API interactions need a valid company_id as HTTP Header for declaration purpose. A full list of companies is accessible via /public/company-list接口来查询list end point. |
Warehouse | /Warehouse每个公司下可以有一个或者多个仓库。所有实际库存均存在在不同的仓库下。请勿将"仓"与"仓库"概念混淆。 (Not accessible by Client) | There is one or more Warehouses under one Company. All actual stocks exist in each warehouse. It is not needed by Client to operate on Warehouse end point, however, warehouse_id is needed by some operations. |
Product | /Product每个客户在不同公司下所有的产品种类（SKU）均自动共享，不过产品库存数不同 | All Products (SKU) are shared among companies, their Stock (live_stock) are counted by Company though. |
Consignment | /Consignment订单在用户界面上分为"本地订单"，"专线订单"和"退货订单", "代理订单" 和 "批量订单" 五种。基本接口均为 /Consignment 。 通过订单下地type类别来识别，分别相对应的是LOCAL,DIRECT, RETURN, AGENT 和 BATCH。Local Consignment本地订单为最基本的仓储配送服务类型，需要在当前仓库先有库存后才可下单，否则系统会提示报错。Direct Consignment专线订单为客户自主发货服务，系统中无需有库存，但是需要通过鸟系统的订单信息来打印相应地址贴。此类订单计费方式同本地订单为按单收费。Return Consignment退货订单，当客户需要退货管理服务时在此下单。Agent Consignment 代理订单主要用作帮助客户记录其他非鸟系统提供得邮递服务的订单记账功能。 目前我们仅支持DHL的订单汇总文件。Batch Consignment批量订单与专线订单类似，不同之处在于批量订单是按照整体重量收费的 | On the web page interface there are five different Consignment types: Local Consignment, Direct Consignment, Return Consignment, Agent Consignment and Batch Consignment. All five consignment types are accessible via the same end point: /Consignment. A 'type' field is used to distinguish different types, they are LOCAL, DIRECT, RETURN, AGENT and BATCH accordingly. ('LOCAL' by default) Local Consignment is designed to be the most basic consignment type which needs actual stock in the local warehouse in order to send a parcel. Direct Consignment is for client to sent consignments directly from their own premise, without actual stock in the warehouse. BirdSystem is responsible for producing address label. Product details such as weight and dimensions are needed in order to calculate correct fee for each consignment. Return Consignment can produce a return label so buyers can return products back to our warehouse. Agent Consignment is for client to use BirdSystem as a gateway to place order and keep record of the consignment fee. Batch Consignment is similar to Agent Consignment however it records the consignment fee by batch. |
Temp Consignment Info | /Temp-Consignment-InfoConsignment一次只可手工添加一次，为了方便客户使用，批量订单允许批量将从eBay和Amazon平台下载的订单记录批量上传，通过触发 | Traditionally Consignment can only be added one by one, to allow importing order details in bulk, client can upload sales orders from eBay and Amazon to Temp Consignment Info and trigger /Temp-Consignment-Info/Convert-Into-Consignment接口批量转换为相应地订单。Consignment End Point to convert them into proper consignments. |
Delivery Service | /Delivery-Service每个公司下均有依当地实情的不同邮递服务，客户在下订单的时候必须先指定所需服务。 (Read Only to Client) | Each Company has different Delivery Services, Client needs to specify delivery_service_id for each Consignment when placing order. This End Point it Ready Only to Client. |
Warehouse Dispatch Freight | /Warehouse-Dispatch-Freight 每个公司下均有依当地事情的不同的头程物流计划，客户在下单头程物流发货单的时候，将会参照头程物流计划中的信息做出计划安排（实际发货情况以仓库为准）(Read Only to Client) | When dispatching products into warehouse, Client need to specify which batch (Warehouse Dispatch Freight) to go with. |
Client Dispatch | /Client-Dispatch | 客户的头程物流发货单 |
...
A Client Dispatch means a batch of products Client to send to Warehouse. |