Consignment Field Updatereview the methods associated with updating indiviual fields against a consignment
The ConsignmentField API method allows only
HTTP Post actions at this moment in time. The
HTTP Post should be used if you require to update a single field against a consignment. You will need to refer to a help article for detailed information regarding the available fields or contact TransVirtual.
Note: this API call is diabled by default, to enable review your API system settings.
Allows you to update a single field against a consignment.
|ConsignmentNumber||The consignment number. This must be provided in the absence of Id, Barcode, UniqueId.|
|Barcode||The article barcode of a item. This must be provided in the absence of Id, UniqueId, ConsignmentNumber.|
|Id||The TransVirtual Id of the consignment. This must be provided in the absence of UniqueId, Barcode, ConsignmentNumber.|
|UniqueId||A unique key value that your system will identify with the consignment. This must be provided in the absence of Id, Barcode, ConsignmentNumber.|
|Field||Field that is to be updated, refer to article for full list of valid field values.|
|Value||The field will be updated to this value (ensure value will fit into field type. Example a number field types will require a number string, not a alpha string value).|
The response properties for the
HTTP Post will be empty
|1401||Missing field to be updated|
|1402||Unknown error - report if this persists|
|1403||Missing update value|
|1404||Missing a valid consignment link number, such as consignment number|
|1405||More then 1 consignment discovered|