GET /apiv2/consignments/getRecentlyCreatedOrUpdatedConsignments
Servers
- /
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
includeChildCompanies |
Boolean | No |
if the query is desired to be made for an organisation that has multiple companies you can set this field to be true Default value: false |
toDateUtc |
String | No |
Optional - This max time period which the consignment updates are to be queried from |
companyId |
Integer | No |
Optional - The company id for the consignments that are being queried |
startIndex |
Integer | No |
Defaults to 1 - MachShip will return a maximum of 200 entries per request. Should there be more than 200 updated or created consignments during the requested time period then you can utilise this index to obtain the next 200 entries by setting this to be 201. This can be repeated until all updates have been obtained. Default value: 1 |
carrierId |
Integer | No |
Optional - If you wish to restrict the updates to a set carrier then you can set the id of that carrier in the request |
retrieveSize |
Integer | No |
This will be between 40 and 200 and will be the number of consignments returned in the request. If not provided the default returned will be 40. Default value: 40 |
getReconciliationData |
Boolean | No |
whether the query should return reconciliation data for the consignments or not Default value: false |
fromDateUtc |
String | No |
Required - This time period from which the consignment updates are to be queried from |
getNotes |
Boolean | No |
whether the query should return notes for the consignments or not Default value: false |
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.