Get Recently Created or Updated Consignments
machship_get_recent_consignmentsRetrieves consignments created or updated within a UTC date range for sync and polling workflows, with pagination, carrier filtering, and optional notes or reconciliation data.
Instructions
Returns consignments created or updated within a UTC date range. Ideal for sync/polling workflows.
Args:
companyId (number): Company ID
fromDateUtc (string): Start datetime in UTC (ISO 8601)
toDateUtc (string): End datetime in UTC (ISO 8601)
startIndex (number, optional): Pagination start index
retrieveSize (number, optional): Number to retrieve
carrierId (number, optional): Filter by carrier
includeChildCompanies (boolean, optional): Include sub-companies
getNotes (boolean, optional): Include notes in response
getReconciliationData (boolean, optional): Include reconciliation data
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>",
"fromDateUtc": "<fromDateUtc>",
"toDateUtc": "<toDateUtc>"
},
"name": "machship_get_recent_consignments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| getNotes | No | Include notes in the response | |
| carrierId | No | Filter by carrier ID | |
| companyId | Yes | Company ID | |
| toDateUtc | Yes | End datetime UTC (ISO 8601) | |
| startIndex | No | Pagination start index (default 1) | |
| fromDateUtc | Yes | Start datetime UTC (ISO 8601) | |
| retrieveSize | No | Number of results to return (default 40, max 200) | |
| getReconciliationData | No | Include reconciliation data in the response | |
| includeChildCompanies | No | Include consignments from 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 |