consignment

URI: http://test.birdsystem.com/client/consignment

Column

Field	Usage	Mandatory	Data Type
id	ID		BINGINT(16)
client_id	Client ID		INT(10)
is_urgent	‘1’ to indict it's an urgent order		TINYINT(1)
delivery_service_id	Delivery Service ID	YES	INT(4)
sales_reference	Sales reference		VARCHAR(50)
delivery_reference	Delivery Reference		VARCHAR(50)
arrive_time	Package arrival time		TIMESTAMP
update_time	Latest update time		TIMESTAMP
contact	Recipient contact	YES	VARCHAR(100)
business_name	Recipient business name		VARCHAR(255)
address_line1	Recipient address line 1		VARCHAR(100)
address_line2	Recipient address line 2		VARCHAR(100)
address_line3	Recipient address line 3		VARCHAR(100)
city	Recipient city		VARCHAR(50)
county	Recipient county / province		VARCHAR(50)
post_code	Recipient post code		VARCHAR(10)
country_iso	Recipient country ISO code	YES	CHAR(2)
telephone	Recipient telephone number		VARCHAR(50)
email	Recipient email		VARCHAR(255)
special_instruction:	Special notice		VARCHAR(255)
neighbour_instruction:	Notice to neighbour		VARCHAR(255)
type	Consignment Type		ENUM('LOCAL','DIRECT','RETURN','AGENT_DIRECT')
Status	Consignment Status		ENUM('PREPARING' , 'RECEIVED' , 'PENDING' , 'WAIT_PICKING' , 'PICKING' , 'PROCESSING' , 'REVIEWING' , 'FINISHED' , 'DELETED' , 'CANCELLED' , 'PROBLEM' , 'WAITING_CLIENT_RESPOND' , 'WAITING_WAREHOUSE_RESPOND')

GET Url Param

Field	Usage	Example
id	Consignment ID	id=1707170020000004

GET Response

{
    "total":1,
    "data":[
        {
            "commodity_code":null,
            "total_price_customs_export":null,
            "name_customs":null,
            "total_quantity":null,
            "weight":null,
            "price":null,
            "price_customs_export":null,
            "period":null,
            "type":"LOCAL",
            "total":null,
            "external_code":null,
            "external_code1":null,
            "external_code2":null,
            "max_length":null,
            "max_width":null,
            "max_depth":null,
            "handling_fee_first_item":null,
            "handling_fee_other_item":null,
            "handling_fee_first_product":null,
            "handling_fee_other_product":null,
            "handling_fee":null,
            "handling_fee_urgent_consignment":null,
            "handling_fee_limit":null,
            "delivery_fee":null,
            "delivery_fee_type":null,
            "return_consignment_id":null,
            "return_consignment_action_type":null,
            "return_consignment_action_name":null,
            "quantity":null,
            "battery_type_name_list":null,
            "delivery_service_name":"Royal Mail",
            "sku_count":null,
            "product_company_ref":null,
            "id":1707170020000004,
            "company_id":2,
            "client_id":1,
            "warehouse_id":null,
            "consignment_product_quantity":1,
            "consignment_product_reference":"1",
            "delivery_service_id":1471,
            "delivery_service_id_internal":1471,
            "delivery_package_size_id":432,
            "total_price":"0.00",
            "total_delivery_fee":"999.00",
            "total_handling_fee":"0.00",
            "total_weight":"30.00",
            "total_volume":"504000.00",
            "total_volume_weight":"504000.0000",
            "guarantee_percentage":"0.00",
            "contact":"Eddie dawson",
            "business_name":null,
            "address_line1":"37 LYNAS gardens",
            "address_line2":"Grassendale",
            "address_line3":null,
            "city":"liverpool",
            "county":"Merseyside",
            "post_code":"l199bl",
            "country_iso":"GB",
            "telephone":"Tel:01519033363",
            "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":"3",
            "payment_reference":null,
            "delivery_reference":null,
            "tracking_reference":null,
            "special_instruction":null,
            "neighbour_instruction":null,
            "temp_consignment_info_id":3,
            "is_urgent":0,
            "is_forced_delivery_service":0,
            "create_time":"2017-07-18 01:04:34",
            "finish_time":"2017-06-21 08:00:00",
            "arrive_time":null,
            "update_time":"2017-06-30 08:00:00",
            "status":"FINISHED",
            "primary_keys":[
                "id"
            ],
            "delivery_service_special_type":"HKSP",
            "delivery_service_is_use_delivery_agent_account_address":1,
            "consignment_delivery_agent-net17track_code":"ZZ",
            "country_name":"UNITED KINGDOM"
        }
    ],
    "success":true,
    "moduleName":"client"
}

Note

Please notice Delivery Service ID is related to the Company ID you use and Country / Post Code where the consignment is sent to. When error occurred during placing order please validate Delivery Service first.

Local consignment uses the following Status:
'PREPARING'
'PENDING'
'WAIT_PICKING'
'PICKING'
'PROCESSING'
'REVIEWING'
'FINISHED'
'DELETED'
'CANCELLED'
Local consignment status flow: Preparing → Pending → Wait Picking → Picking → Processing → (Reviewing) → Finished

Return consignment uses the following status:
'PREPARING'
'RECEIVED'
'PENDING'
'PROCESSING'
'REVIEWING'
'FINISHED'
'DELETED'
'CANCELLED'
'PROBLEM'
Return consignment status flow: Preparing → Received → pending → Processing → (Reviewing) → Finished

Agent direct consignment uses the following status:

'PREPARING'
'PENDING'
'PROCESSING'
'FINISHED'
'DELETED'

Agent direct consignment status flow: Preparing → Pending → Processing → Finished