Consignment Field Update
review the methods associated with updating indiviual fields against a consignment/Api/ConsignmentField
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.
HTTP Post
Allows you to update a single field against a consignment.
Request Properties
Property Name | Required | Description |
---|---|---|
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). |
Response Properties
The response properties for the HTTP Post
will be empty
Example Post
Request (json)
Response (json)
Error Codes
Error Code | Description |
---|---|
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 |