Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

URI: http://test.birdsystem.co.uk/client/consignment

...

FieldUsageMandatoryData Type

id

ID


BINGINT(16)

client_id

Client ID号码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_referenceDelivery 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')

StatusConsignment Status
ENUM('PREPARING' , 'RECEIVED' , 'PENDING' , 'WAIT_PICKING' , 'PICKING' , 'PROCESSING' , 'REVIEWING' , 'FINISHED' , 'DELETED' , 'CANCELLED' , 'PROBLEM' , 'WAITING_CLIENT_RESPOND' , 'WAITING_WAREHOUSE_RESPOND')


GET Url Param

Param NameFieldCommentUsageExample

id

Consignment ID

id=1707170020000004

...