Consignment Additional Service

review the methods associated with inserting additional services against a consignment

/Api/ConsignmentAdditionalService

The ConsignmentAdditionalService API method allows only HTTP Post actions at this moment in time. The HTTP Post should be used for all fresh inserts of additional services against a given consignment. Note: the additional service must exist and can only be added once per consignment via this method.

Note: this API call is diabled by default, to enable review your API system settings.

HTTP Post

Allows you to insert a new additional service against a consignment.

Request Properties

Property Name	Required	Description
ConsignmentNumber		The consignment number. This must be provided in the absence of Id, UniqueId.
Id		The TransVirtual Id of the consignment. This must be provided in the absence of UniqueId, ConsignmentNumber.
UniqueId		A unique key value that your system will identify with the consignment. This must be provided in the absence of Id, ConsignmentNumber.
UserNotes		Optional driver/user notes that you would like to place against the additional service.
AdditionalServiceName		The name of the additional service.
AdditionalServiceChargeRateOverride		Optional - A charge value that will override any system generated rates.
AdditionalServiceQtyOverride		Optional - A quantity value you would like to assign to the additional service, will default to 1.
AdditionalServicePickupRelated		Optional - Is the additional service related to a pickup activity, defaults to false.
AdditionalServiceAgentName		Optional agent name you would like to also pay an agent.
AdditionalServiceApprovalRequired		Optional - Will the additional service require approval via administrators, defaults to false.
AdditionalServiceCreatedBy		Optional name to be applied against the additional service of who created it.

Response Properties

The response properties for the HTTP Post will be empty

Example Post

Request (json)


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

            {"ConsignmentNumber":"000000", "AdditionalServiceName":"Hand Unload"}

Response (json)


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

            {"TransactionID":11244,"StatusCode":200,"StatusText":"OK", "Data":{}}

Error Codes

Error Code	Description
1501	Unknown error - report if this persists
1502	Missing a valid consignment link number, such as consignment number
1503	More then 1 consignment discovered
1504	Additional service was not discovered
1505	Missing additional service name
1506	Additional service already exists