Get Recently Created/Updated Pending Consignments
machship_get_recent_pending_consignmentsRetrieve pending consignments created or updated within a UTC date range to support sync workflows and keep shipment records current.
Instructions
Returns pending consignments created or updated within a UTC date range. Useful for sync workflows.
Args:
companyId (number): Company ID
fromDateUtc (string): Start datetime UTC (ISO 8601)
toDateUtc (string): End datetime UTC (ISO 8601)
startIndex (number, optional): Pagination start
retrieveSize (number, optional): Page size
carrierId (number, optional): Filter by carrier
includeChildCompanies (boolean, optional): Include sub-companies
getDeleted (boolean, optional): Include deleted pending consignments
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| carrierId | No | Filter by carrier ID | |
| companyId | Yes | Company ID | |
| toDateUtc | Yes | End datetime UTC (ISO 8601) | |
| getDeleted | No | Include deleted pending consignments | |
| startIndex | No | Pagination start index | |
| fromDateUtc | Yes | Start datetime UTC (ISO 8601) | |
| retrieveSize | No | Number of results to return (max 200) | |
| includeChildCompanies | No | Include pending 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 |