Get Active Consignments
machship_get_active_consignmentsRetrieve active in-transit consignments for a company, with optional carrier, pagination, and child-company filters to monitor freight shipments.
Instructions
Returns all active (in-transit) consignments for a company.
Args:
companyId (number): Company ID
startIndex (number, optional): Pagination start index
retrieveSize (number, optional): Number to retrieve
carrierId (number, optional): Filter by carrier
includeChildCompanies (boolean, optional): Include sub-companies
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"companyId": "<companyId>"
},
"name": "machship_get_active_consignments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| carrierId | No | Filter by carrier ID | |
| companyId | Yes | Company ID | |
| startIndex | No | Pagination start index | |
| retrieveSize | No | Items to retrieve | |
| includeChildCompanies | No | Include child companies |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation errors returned by Machship, if any | |
| object | No | Response payload from the Machship API |