POST /apiv2/consignments/updateConsignmentStatuses
Servers
- /
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
[] |
Array | Yes | |
[].itemReference |
String | No |
When present this tracking status relates to an item on the consignment. When absent it relates to the consignment as a whole. |
[].status |
Integer | No |
Note that this enum reflects the entries in the ConsignmentTrackingStatus table. The Enums integer values should map to the id field of the status. Also note that if any statuses are added in here, then they also may need to be added in the ConsignmentTrackingHistoryService.GetEligibleNewStatusesForConsignment() logic when determining which statuses can be changed into a different status1 = Quote, 2 = Unmanifested, 3 = Manifested, 4 = Booked, 5 = InTransit, 6 = Delayed, 7 = Complete, 8 = Lost, 9 = Damaged, 10 = Cancelled, 13 = OnForDelivery, 14 = AddedToMachship, 15 = PickedUp, 16 = ScannedIntoDepot, 17 = DeliveryAttempted, 18 = SortedForDelivery, 19 = PartialDelivery, 20 = DeliveryTimeScheduled, 21 = Deleted, 22 = AtDelivery, 23 = PartialOnForDelivery, 24 = AtPickup, 25 = Manifesting, 26 = TrackingExpired, 27 = FailedPickup, 28 = FailedDelivery, 29 = AwaitingCollection, 30 = CompleteReturnedToSender Possible values:
|
[].consignmentId |
Integer | No |
The ID of the consignment in MachShip |
[].statusDateTimeLocal |
String | No |
Optional. |
[].extraInformation |
String | No |
Any extra information about this status - this will be shown in MachShip when viewing the tracking history |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.