POST /apiv2/consolidation/groupConsignmentsForConsolidation
Servers
- /
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
doNotConsolidate |
Boolean | No |
Set this flag to true when you do not want to consolidate, rather you just want the consignments to be returned to be abl to perform a bulk update |
consolidationTarget |
Integer | No |
Which type of consignments to target for consolidation0 = Unmanifested, 1 = Pending, 2 = Both Possible values:
|
groupByReferenceOne |
Boolean | No |
Whether the first customer reference be used when grouping consignments for consolidation |
groupByService |
Boolean | No |
Whether the service will be considered when consolidating consignments (only relevant when Machship.Common.Models.Consolidation.ConsolidationOptions.GroupByCarrier is also set to true) |
companyId |
Integer | No |
The Machship Company ID that consolidation should be performed for - if omitted it will be performed against the company of the user performing consolidation |
groupByReferenceTwo |
Boolean | No |
Whether the second customer reference be used when grouping consignments for consolidation |
groupByCarrier |
Boolean | No |
Whether the carrier will be considered when consolidating consignments |
defaultRouteSelection |
Integer | No |
0 = Cheapest, 1 = Fastest Possible values:
|
errorHandling |
Integer | No |
0 = DoNotConsolidateOnAnyError, 1 = ConsolidateValidConsignments Possible values:
|
pendingConsignmentIds[] |
Array | No |
Optional - list of pending consignment IDs to attempt to consolidate. Will not be considered if Machship.Common.Models.Consolidation.ConsolidationOptions.ConsolidationTarget is set to Machship.Common.Models.Consolidation.Enums.ConsolidationTarget.Unmanifested. If omitted all pending consignments will be used to attempt consolidation. |
preventFutureDateConsoldation |
Boolean | No | |
groupByDespatchDate |
Boolean | No |
Whether the despatch date be used when grouping consignments for consolidation |
unmanifestedConsignmentIds[] |
Array | No |
Optional - list of unmanifested consignment IDs to attempt to consolidate. Will not be considered if Machship.Common.Models.Consolidation.ConsolidationOptions.ConsolidationTarget is set to Machship.Common.Models.Consolidation.Enums.ConsolidationTarget.Pending. If omitted all unmanifested consignments will be used to attempt consolidation. |
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.