Consignment Query

review the methods associated with consignment data query

/Api/ConsignmentQuery

The consignment query API method allows only HTTP Post actions at this moment in time. The HTTP Post should be used for all requests of consignment data and will return just the consignment static data such as sender, receiver items. If you require status and other live information you will need to user other parts of the API or generate automated export rules within your TransVirtual export functions

HTTP Post

Allows you to request the consignment data from the TransVirtual database, does not provide any status information.

Request Properties

Property Name	Required	Description
ConsignmentNumber		The consignment number. If this is not provided, the barcode is required
Barcode		The article barcode of a item. If this is not provide, the consignment number is required
IncludeLabelsPdf		If true include consignment labels in response
IncludeConsignmentPdf		If true include consignment PDF in response

Response Properties

Property Name	Description
Number	Consignment number (also the tracking number). Max length: 100
CustomerName	The customer name of this consignment. Max length: 200
SenderName	The senders name. Max length: 100
SenderAddress	The senders address (line 1). Max length: 100
SenderAddress2	The senders address (line 2). Max length: 100
SenderSuburb	The senders suburb. Max length: 60
SenderPostcode	The senders postcode. Max length: 20
SenderState	The senders state/province. Max length: 30
ReceiverName	The receiver name. Max length: 100
ReceiverAddress	The receivers address (line 1). Max length: 100
ReceiverAddress2	The receivers address (line 2). Max length: 100
ReceiverSuburb	The receivers suburb. Max length: 60
ReceiverPostcode	The receivers postcode. Max length: 20
ReceiverState	The receivers state/province. Max length: 30
SenderReference	Senders reference for the consignment. Max length: 100
ReceiverReference	Receivers reference for the consignment. Max length: 100
SenderEmail	Sender email address that will be sent tracking info. Max length: 500
ReceiverEmail	Receiver email address that will be sent tracking info. Max length: 500
SpecialInstructions	Instructions given for the delivery, and will appear on mobile devices for delivery driver. Max length: 500
ConsignmentSenderContact	Senders contact name, will assist with pickup details. Max length: 100
ConsignmentSenderPhone	Senders contact number, will assist with pickup details. max length: 50
ConsignmentReceiverContact	Receivers contact name, will assist with delivery details. Max length: 100
ConsignmentReceiverPhone	Receivers contact number, will assist with delivery details. Max length: 50
DangerousGoodsNotes	Dangerous goods notes (Hazard material). If this field has a value, it will indicate the consignment contains dangerous goods, Max length: 200
ConsignmentLengthUom	The unit of measure for the length values
ConsignmentPickupSpecialInstructions	Instructions given for the pickup instructions, will appear on mobile devices for pickup driver. Max length: 500
PickupRequest	If the consignment still requires a pickup, value will be y
ConsignmentOtherReferences	Place all remaining references in this field seperated by \|. Max length: 500
ConsignmentBookingReference	References the driver will require on pickup. Max length: 500
ConsignmentPickupBookingReference	References the driver will require on delivery.
ConsignmentTotalWeightOverride	Override total weight display - ignores the summation of the item weight values. Integer
ServiceType	The service level of the consignment. Max length: 50
LabelsPdf	Base64 encoded consignment label PDF data
ConsignmentPdf	Base64 encoded consignment PDF data

Rows

Property Name	Description
Qty	The number of items in this row. Integer
QtyDecimal	The number of items in this row. Decimal (Optional)
Description	The description given to this row of items
Weight	The total weight of this row of items. Integer
Length	The length of each (or total) of the row of items - Used with CubicQty field. Decimal
Width	The Width of each (or total) of the row of items - Used with CubicQty field. Decimal
Height	The Height of each (or total) of the row of items - Used with CubicQty field. Decimal
CubicQty	The qty to multiply with the Length/Width/Height to calculate total cubic. Decimal
Reference	Reference number given to this row of items
StockCode	A stock code for this row of items
Uom	The unit of measure for the weight value

Items

Property Name	Description
Barcode	The article barcode of the item

Example Post

Request (json)


                    POST /Api/ConsignmentQuery HTTP/1.1
            Host: api.transvirtual.com.au
            Accept: */*
            Authorization: 11111|QHYKGDFDSL
            Content-Type: application/json
            Content-Length: 0

            {"ConsignmentNumber":"AA112444", "ScanCode":"AA1124440001"}

Response (json)


                    HTTP/1.1 200 OK
            Content-Type: application/json; charset=utf-8
            Content-Length: 82

            {"TransactionID":11244,"StatusCode":200,"StatusText":"OK",
            "Data":{ "Number" : "AA112444", "SenderName" : "Test Sender" .... 
            "Rows":[
            "Qty":4, "Description" : "Carton", ....
            "Items":[
            "Barcode":"GA77485001"
            ]
            ]}
            }

Error Codes

Error Code	Description
1301	Does not exist
1302	No values provided