POST /apiv2/pendingConsignments/returnPendingConsignmentsByReference1

Get Pending Consignment Details for multiple pending consignments using Reference 1 as the lookup. Maximum of 10 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.
`onlyPendingStatus`	Boolean	No	Optional, defaults to false. Filters on the pending consignment's `Status` field: when true only records whose status is `Pending` (the normal resting state) are returned, excluding those currently mid-consolidation (`Consolidating`). This matches what the pending consignments grid displays. The default returns any active record regardless of status. 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.

onlyPendingStatus

Boolean

Optional, defaults to false. Filters on the pending consignment's Status field: when true only records whose status is Pending (the normal resting state) are returned, excluding those currently mid-consolidation (Consolidating). This matches what the pending consignments grid displays. The default returns any active record regardless of status.

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.