/Api/ConsignmentItem

The consignment Item API method allows HTTP Post action only. The HTTP Post should be used against existing consignments and will insert the extra consignment item rows as provided.

HTTP Post

Allows you to insert a new consignment row summary (items) into your TransVirtual database against an existing consignment that exists on a open customer manifest.

Request Properties

Property Name Required Description
ReturnAllPdfLabels Include all PDF of Labels in response (Base64Encoded) - 'y' to include
ReturnNewPdfLabels Include PDF of new Labels only in response (Base64Encoded) - 'y' to include
ReturnPdfConsignment Include PDF of Consignment in response (Base64Encoded) - 'y' to include
Number Consignment number (also the tracking number). Max length: 100
UniqueId A unique key value that your system will identify with the consignment. Max length: 200
IdConsignment A Transvirtual unique key value that we provide on API insert. long
CustomerName Yes The customer name of this account (if not known, customer account must be supplied if only consignment number is provided). Max length: 200
CustomerCode Yes The customer account code of this account (if not known, customer name must be supplied if only consignment number is provided). Max length: 20

Property Name Required Description
RemoteRowUniqueId Remote Unique Row ID - used in API ConsignmentItem Post. Max length: 200
Qty Yes The number of items in this row. Integer
QtyDecimal The number of items in this row. Decimal
Description Yes The description given to this row of items. Max length: 200
ItemContentsDescription Yes The freight contents description given to this row of items. Max length: 200
ItemRowChargeQty Allows you to override the charge qty only
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
CubicTotalFallback The item row total cubic used as fallback only if no dimensions provided. Decimal
CubicTotalConsignment The item row total cubic used as fallback only if no dimensions provided. Will not be summed if item rows are combined. Decimal
Reference A reference number given to this row of items. Max length: 50
StockCode A stock code for this row of items. Max length: 50
Uom Values can only be kgs, oz, lb, ton, tonne
DangerousGoodsNotes Dangerous Goods notes (Hazard material) - Item Level. If this field has a value, it will indicate the consignment contains dangerous goods, Max length: 200
DangerousGoodsUNNumber Dangerous Goods UN Number (Hazard material) - Item Level. If this field has a value, it will be used with Class, Packaging Group and Subrisk to find exact lookup, Max length: 50
DangerousGoodsClass Dangerous Goods Class (Hazard material) - Item Level. If this field has a value, it will be used with UN Number, Packaging Group and Subrisk to find exact lookup, Max length: 50
DangerousGoodsPackagingGroup Dangerous goods Packaging Group (Hazard material) - Item Level. If this field has a value, it will be used with Class, UN Number and Subrisk to find exact lookup, Max length: 50
DangerousGoodsSubRisk Dangerous Goods SubRisk (Hazard material) - Item Level. If this field has a value, it will be used with Class, UN Number and Packaging Group to find exact lookup, Max length: 150
DangerousGoodsUNNumber2 2nd Dangerous Goods UN Number (Hazard material) - Item Level. If this field has a value, it will be used with Class, Packaging Group and Subrisk to find exact lookup, Max length: 50
DangerousGoodsClass2 2nd Dangerous Goods Class (Hazard material) - Item Level. If this field has a value, it will be used with UN Number, Packaging Group and Subrisk to find exact lookup, Max length: 50
DangerousGoodsPackagingGroup2 2nd Dangerous Goods Packaging Group (Hazard material) - Item Level. If this field has a value, it will be used with Class, UN Number and Subrisk to find exact lookup, Max length: 50
DangerousGoodsSubRisk2 2nd Dangerous Goods SubRisk (Hazard material) - Item Level. If this field has a value, it will be used with Class, UN Number and Packaging Group to find exact lookup, Max length: 150
DangerousGoodsContainerType 2nd Dangerous Goods Container Type (Hazard material) - Item Level. Optional user along side UN Number, Max length: 200
DangerousGoodsNumberOfContainers Dangerous Goods Number of Containers (Hazard material) - Item Level. Optional user along side UN Number, Max length: 50
DangerousGoodsAggregateWeight Dangerous Goods Aggregate Weight (Hazard material) - Item Level. Optional user along side UN Number, Max length: 50
DangerousGoodsContainerType2 2nd Dangerous Goods Container Type (Hazard material) - Item Level. Optional user along side UN Number, Max length: 200
DangerousGoodsNumberOfContainers2 2nd Dangerous Goods Number of Containers (Hazard material) - Item Level. Optional user along side UN Number, Max length: 50
DangerousGoodsAggregateWeight2 2nd Dangerous Goods Aggregate Weight (Hazard material) - Item Level. Optional user along side UN Number, Max length: 50

Property Name Required Description
Barcode Yes The article barcode of the item
AlternateBarcode An alternate article barcode of the item - only use if advised

Response Properties

The response properties for the HTTP Post found within the Data field of the reponse

Property Name Description
PdfLabels PDF of Labels (Base64Encoded)
PdfConsignment PDF of Consignment (Base64Encoded)

Example Post

Request (json)
Response (json)

Error Codes

Error Code Description
1401 Missing rows (item data) to insert
1402 Unknown error - report if this persists
1403 Missing a valid consignment link number, such as consignment number
1404 More then 1 consignment discovered
1405 Customer manifest already closed - no edit allowed