1 1. Related API Requests
2 2. All-in-one API Request to create Client-Dispatch
3 3. Update the Status of Client-Dispatch

1. Related API Requests

For those pre-required fields, only Client-Dispatch-Freight ID varies daily, others remain stable

1.1 Get Active Warehouse

/client/Warehouse/Client-Use-Warehouse

1.2 Get Warehouse Dispatch Freight

/client/Warehouse-Dispatch-Freight/Get-Closest-Freight

1.3 Get Client-Dispatch-Vat (Optional)

/client/Client-Dispatch-Vat-Number

1.4 Get Address-Book (Optional)

/client/Address-Book

2. All-in-one API Request to create Client-Dispatch

URL

http://test.birdsystem.com/client/Client-Dispatch-Upload/Client-Dispatch-Json

Method

POST

Payload

[{
	"warehouse_id_origination": "22",
	"warehouse_id_destination": "1",
	"final_freight_method": "SEA",
	"warehouse_dispatch_freight_id": "221",
	"delivery_time": "2015-07-31",
	"is_use_whole_warehouse_dispatch_freight": "0",
	"client_dispatch_delivery_type_code": "01",
	"client_vat_number_id": "1",
	"reference": "",
	"delivery_reference": "",
	"type": "NORMAL",
	"client_dispatch_final_address_contact": "howard",
	"client_dispatch_final_address_business_name": "Birdsystem",
	"final_address_line1": "320 Regent Street",
	"final_address_line2": "",
	"final_address_line3": "",
	"client_dispatch_final_address_city": "London",
	"client_dispatch_final_address_county": "",
	"client_dispatch_final_address_post_code": "W1B 3BB",
	"client_dispatch_final_address_country_iso": "GB",
	"client_dispatch_final_address_telephone": "6666 6666 666",
	"client_dispatch_final_address_email": "",
	"note": "",
	"client_dispatch_container_product_list": [{
		"client_dispatch_container_reference": "1",
		"client_dispatch_container_type_code": "BIG",
		"client_dispatch_container_weight": "3000",
		"product_id": "175035",
		"quantity": "10"
	}, {
		"client_dispatch_container_reference": "1",
		"client_dispatch_container_type_code": "BIG",
		"client_dispatch_container_weight": "3000",
		"product_id": "175036",
		"quantity": "10"
	}, {
		"client_dispatch_container_reference": "2",
		"client_dispatch_container_type_code": "BIG",
		"client_dispatch_container_weight": "3000",
		"product_id": "175036",
		"quantity": "10"
	}]
}]

Response

{"success":true,"message":null,"data":["8288","8289"]}

Parameters

Field	Comment
warehouse_id_origination	Warehouse ID of where the products will be sent from. Normally this is where Client will send their product Visit /client/Warehouse/Client-Use-Warehouse for list of available warehouses to use
warehouse_id_destination	Warehouse ID of where the products will be sent to. Normally this is where the product will be packed and dispatched to buyer. Visit /client/Warehouse/Client-Use-Warehouse for list of available warehouses to use
is_use_whole_warehouse_dispatch_freight	'true' to set a whole warehouse dispatch freight dedicated for this dispatch.
warehouse_dispatch_freight_id	Defines which freight batch to use. Visit /client/Warehouse-Dispatch-Freight/Get-Closest-Freight to get full list of available freight batches. (With given delivery_time, final_freight_method, warehouse_id_origination, warehouse_id_destination)
client_dispatch_delivery_type_code	Defines how the products will be dealt with after arriving destination warehouse. Visit /client/Client-Dispatch-Delivery-Type for full list of ways the product to be dealt with. If related client_dispatch_delivery_type.is_delivery_to_warehouse=0 then final contact address and country will be mandatory.
client_vat_number_id	VAT Number for current Client Visit /client/Client-Dispatch-Vat-Number for full list of registered VAT numbers
client_dispatch_container_type_code	Container type of client dispatch. Vist /client/Client-Dispatch-Container-Type for full list
final_address_*	Visit /client/Address-Book for final address book, you can also use this API end point to manage your address book.

3. Update the Status of Client-Dispatch

update client dispatch status to 'CLIENT_DISPATCH'

URI: http://test.birdsystem.com/client/Client-Dispatch/Update-Status

GET Url Param

Field	Usage	Mandatory	Example

Field	Usage	Mandatory	Example
ids	Client dispatch ID, use "_" concat when multiple ID	Yes	1_2_3
status	Status	Yes	'CLIENT_DISPATCHED', 'PREPARING', 'DELETED'

Status Explain

Status	Explain

Status	Explain
CLIENT_DISPATCHED	Client dispatch the product
PREPARING	Client preparing the product
DELETE	Client give up dispatching

Response

{"success":true,"refresh":false,"moduleName":"admin"}

Finished

Client-Dispatch API

1. Related API Requests

2. All-in-one API Request to create Client-Dispatch

3. Update the Status of Client-Dispatch

GET Url Param

Status Explain

Response

Comments