GET /apiv2/consignments/getCompleted
Returns consignments for the given company that were completed within the provided start and end date range. Limited to 2000 consignments at a time.Servers
- /
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
endDate |
String | No |
End Date which is compared against the consignment's Completed Date (all date times are local to the delivery location) |
includeChildCompanies |
Boolean | No |
Whether to include companies that are "children" below companyId Default value: false |
companyId |
Integer | No |
Optional - defaults to your company. Must be a valid company ID in MachShip |
startDate |
String | No |
Start Date which is compared against the consignment's Completed Date (all date times are local to the delivery location) |
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.