GET /apiv2/consignments/getUnmanifested

Servers

Query parameters

Name Type Required Description
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

startIndex Integer No

Defaults to 1. Can be used to "page" through subsequent requests

Default value: 1

carrierId Integer No

Optional carrier ID to restrict consignments to those of this carrier

retrieveSize Integer No

The number of consignments to return. Defaults to 40, will return a maximum of 200 rows

Default value: 200

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.