Page Comparison

There are three ways to create Consignments in Birdsystem :

...

Post a request with params below：

url

http://test.birdsystem.co.ukcom/client/Consignment

method

post

body

form parmas:

Field	Description	Mandatory	Date Type
is_urgent	Is urgent?		TINYINT(1)
delivery_service_id	Delivery Service ID	Yes	INT(4)
sales_reference	Sale Reference		VARCHAR(50)
sales_price	Order Sales Price		DECIMAL(10, 3)
sales_order_id	eBay or Amazon order ID		VARCHAR(50)
delivery_reference	Tracking Reference No.		VARCHAR(50)
contact	Contact Name	Yes	VARCHAR(100)
business_name	Business Name		VARCHAR(255)
address_line1	Address Line 1	Yes	VARCHAR(100)
address_line2	Address Line 2		VARCHAR(100)
address_line3	Address Line 3		VARCHAR(100)
city	City	Yes	VARCHAR(50)
county	County		VARCHAR(50)
post_code	Postcode		VARCHAR(10)
country_iso	Country ISO	Yes	CHAR(2)
telephone	Telephone		VARCHAR(50)
email	Email		VARCHAR(255)
special_instruction:	Note1		VARCHAR(255)
neighbour_instruction:	Note2		VARCHAR(255)
type	Consignment Type		ENUM('LOCAL','DIRECT','RETURN','AGENT_DIRECT')

Return

Code Block

language	js

{
    "success":true,
    "data":{
		"id":"2006143004830001",
		"delivery_service_id":"12010433",
		"...":"..."
	}
}

...

This Step is to attach SKU to the Consignment just created.

url

http://test.birdsystem.co.ukcom/client/Consignment-Product

method

post

body

form params:

Field	Description	Mandatory	Date Type
product_id	SKU ID	Yes	INT(10)
consignment_id	Consignment ID	Yes	BINGINT(16)
product_type	SKU Type	Yes	ENUM('NORMAL','DIRECTIONAL')
quantity	SKU Quantity	Yes	SMALLINT(5)

Return

Code Block

language	js

{
    "success":true,
    "data":{
		"id":"1124955",
		"consignment_id":"2006143004830001",
		"product_id":"334422",
		"...":"..."
	}
}

...

The final step is to update the Status of Consignment to the PENDING, which is the status BirdSystem ready to process.

url

http://test.birdsystem.co.ukcom/client/Consignment/Batch-Update-Status

method

post

body

form params:

Field	Description	Mandatory	Date Type
ids	Consignment ID. For multiple consignment, join those IDs with a underscore, for example 123_124.	Yes	VARCHAR(255)
status	Consignment Status	Yes	VARCHAR(10)

Response

Code Block

language	js

{
    "success":true
}

...

Temporary Consignments allows pre-process Consignments and correct some fields for Consignment, then batch converting those Consignment to the final Consignments in BirdSystem

url

http://test.birdsystem.co.ukcom/client/consignment-upload/Temp-Consignment-Json

method

post

body

Fields:


Field	Description	Mandatory	Date Type
delivery_service_name	Delivery Service Name	Yes	INT(4)
sales_reference	Sales Reference		VARCHAR(50)
sales_price	Order Sales Price		DECIMAL(10, 3)
sales_order_id	eBay or Amazon order ID		VARCHAR(50)
delivery_reference	Tracking Reference No.		VARCHAR(50)
contact	Contact Name	Yes	VARCHAR(100)
business_name	Business Name		VARCHAR(255)
address_line1	Address Line 1	Yes	VARCHAR(100)
address_line2	Address Line 2		VARCHAR(100)
address_line3	Address Line 3		VARCHAR(100)
city	City	Yes	VARCHAR(50)
county	County		VARCHAR(50)
post_code	Postcode	Yes	VARCHAR(10)
country_name	Country ISO	Yes	CHAR(2)
telephone	Telephone		VARCHAR(50)
product_company_ref	SKUs and Quantity	Yes	VARCHAR(255)
email	Email		VARCHAR(255)
special_instruction:	Note 1		VARCHAR(255)
neighbour_instruction:	Note 2		VARCHAR(255)

Code Block

language	js

[
    { 
        "contact": "Norman Drury", 
        "business_name": null, 
        "address_line1": "3, Northam Close", 
        "address_line2": "Marshside", 
        "address_line3": null, 
        "city": "Southport", 
        "county": "Merseyside", 
        "post_code": "PR9 9GA", 
        "country_name": "United Kingdom", 
        "telephone": "01704 226830", 
        "email": null, 
        "sales_reference": "2", 
		"sales_order_id": "110222319566-0",
        "payment_reference": "Royal Mail 1st Class Standard", 
        "special_instruction": null, 
        "product_company_ref": "15591*1+215312*1", 
        "delivery_service_name": "Royal Mail 1st Class Standard", 
        "status": "PENDING", 
        "type": "LOCAL", 
        "thirty_system_id":"2222" 
    } 
]

Response

Code Block

language	js

{
    "success":true,
    "message":"File successfully uploaded! 1 records has been imported.",
    "data":{"2222":"12010433"}
}

...

The Status of Consignment will be the PENDING

url

http://test.birdsystem.co.ukcom/client/Temp-Consignment-Info/Convert-Into-Consignment/?ids=12010436_12010437&type=LOCAL&start=0

method

get

body

-

Response

[Response with error ]

Code Block

language	js

{
    "numberOfTotalConsignmentsToProcess": 1,
    "numberOfConsignmentsProcessed": 1,
    "finished": true,
    "data": null,
    "errorIdList": [
        {
            "id": 12010439,
            "message": "Can't find delivery service."
        }
    ],
    "success": true,
    "refresh": false
}

[Success]

Code Block

language	js

{
    "numberOfTotalConsignmentsToProcess": 1,
    "numberOfConsignmentsProcessed": 1,
    "finished": true,
    "data": {
        "12010439": "1507310110000001"
    },
    "errorIdList": [],
    "success": true,
    "refresh": false
}

Description of Response Fields

numberOfTotalConsignmentsToProcess: Total Number of Consignment to Process
numberOfConsignmentsProcessed: Processed Number of Consigment for this Request
finished: Have all temporary Consignments converted to the final Consignments
data: The key pairs of temporary Consignments and the fianl Consignment
Conventionaly Birdsystem process 25 temporary Consignemnt for each Request.
So when 'finished' in response is with 'false', then set param of 'start ' += numberOfConsignmentsProcessed to do another Request, until all temporary Consignment processed

Params

ids: Temporary Consignment IDs, join IDs with underscore when multiple. for example: 123_124_125 [Optional]
type: Consignment Type. [Required]
start: The start offset of temporary Consignments to Process [Required]

4 Creating a Consignment in a all-in-one API Request

url

http://test.birdsystem.co.ukcom/client/Consignment/Post-Pending-Consignment-With-Products-Json

method

post

body

Code Block

language	js

[
    {
        "contact": "Norman Drury",
        "business_name": null,
        "address_line1": "3, Northam Close",
        "address_line2": "Marshside",
        "address_line3": null,
        "city": "Southport",
        "county": "Merseyside",
        "post_code": "PR9 9GA",
        "country_iso": "GB",
        "telephone": "01704 226830",
        "email": null,
        "delivery_service_id": "1471",
        "sales_reference": "2",
		"sales_price": 21.99
		"sales_order_id": "110222319566-0",
        "special_instruction": null,
        "products":[
        	{"client_sku":"IP-XX3355","quantity":5},
        	{"id":2,"quantity":4}
        ]
    }
]

Response

Code Block

language	js

{
  "success": true,
  "data": [
    {
      "id": 1612120020000011,
      "company_id": 2,
      "client_id": 1,
      "consignment_product_quantity": 9,
      "consignment_product_reference": "1,2",
      "delivery_service_id": 1471,
      "delivery_service_id_internal": 1471,
      "delivery_package_size_id": 432,
      "delivery_package_size_id_internal": 432,
      "total_price": "0.00",
      "total_cost": "0.00",
      "...": "...",
	  "contact": "Norman Drury",
      "business_name": null,
      "address_line1": "3, Northam Close",
      "address_line2": "Marshside",
      "address_line3": null,
      "city": "Southport",
      "county": "Merseyside",
      "post_code": "PR9 9GA",
      "country_iso": "GB",
      "telephone": "01704 226830",
      "email": null,
      "sales_reference": "2",
	  "sales_order_id": "110222319566-0",
    }
  ]
}

Params

Field	Description	Mandatory	Date Type
is_urgent	Is Urgent ?		TINYINT(1)
delivery_service_id OR delivery_service_name	ID or Name of Delivery Service	Yes	INT(4)/VARCHAR(50)
sales_reference	Sales Reference		VARCHAR(50)
sales_price	Order Sales Price		DECIMAL(10, 3)
sales_order_id	eBay or Amazon order ID		VARCHAR(50)
delivery_reference	Tracking Reference No.		VARCHAR(50)
contact	Contact Name	Yes	VARCHAR(100)
business_name	Business Name		VARCHAR(255)
address_line1	Address Line 1		VARCHAR(100)
address_line2	Address Line 2		VARCHAR(100)
address_line3	Address Line 3		VARCHAR(100)
city	City		VARCHAR(50)
county	County		VARCHAR(50)
post_code	Postcode		VARCHAR(10)
country_iso	Country ISO	Yes	CHAR(2)
telephone	Telephone		VARCHAR(50)
email	Email		VARCHAR(255)
special_instruction:	Note 1		VARCHAR(255)
neighbour_instruction:	Note 2		VARCHAR(255)
products	SKU Reference or ID	Yes	Example: [ {"client_sku":”IP-XX3355”,"quantity":5}, {"id":2,"quantity":4} ]
parcel_pieces	parcel piece information	Optional	Example： [ {"weight":500, "length":25, "width":20, "depth":15, "description":"table"}, {"weight":400, "length":22, "width":18, "depth":13, "description":"chair"}, ] Note：Unit of Weight: g (gram)，Unit of Dimension: mm (millimetre)

...

Versions Compared

Old Version 18

New Version 19

Key

4 Creating a Consignment in a all-in-one API Request