POST /apiv2/consignments/returnConsignmentsByCarrierConsignmentId

Get Consignment Details for a multiple consignments using the Carrier Consignment ID as the lookup. Maximum of 10 consignments per request

Servers

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`includeChildCompanies`	Boolean	No	Optional, defaults to true. When true the whole accessible company tree below companyId is searched. Set to false to restrict the lookup to companyId alone. Default value: true
`companyId`	Integer	No	Optional. Restricts the lookup to this company. Must be within the caller's accessible companies, otherwise a "Company Not Found" validation error is returned. When omitted the caller's base company is used.
`includeDeleted`	Boolean	No	If true, will also return details for deleted consignments Default value: false

includeChildCompanies

Boolean

Optional, defaults to true. When true the whole accessible company tree below companyId is searched. Set to false to restrict the lookup to companyId alone.

Default value: true

companyId

Integer

Optional. Restricts the lookup to this company. Must be within the caller's accessible companies, otherwise a "Company Not Found" validation error is returned. When omitted the caller's base company is used.

includeDeleted

Boolean

If true, will also return details for deleted consignments

Default value: false

Request body fields

Name	Type	Required	Description
`[]`	Array	Yes

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.