Search shipments and orders matching an exact reference value at a given facility. Shipments match on id, reference id, BOL, PRO, any one of their POs or of their linked orders' POs, customer reference or a custom reference; orders on id, order number, name, PO, SO, customer reference or a custom reference. A custom reference is a custom field of any type of the facility owner that the caller may see: any one for the owner's own users, only those visible to carriers for anyone else. A text value matches as is, a number by its text; a true/false value never matches. matches names, per returned shipment and order, the field that matched. Shipment custom_data is whole for the owner's own users and holds only custom fields visible to carriers for anyone else. incomplete says whether matches may be missing because part of the search could not run.
Successful Response
Validation Error
{- "shipments": [
- {
- "id": "string",
- "state": "string",
- "stops": [
- {
- "id": "string",
- "is_pickup": true,
- "is_dropoff": true,
- "planned_date": "2019-08-24",
- "planned_time_window_start": "14:15:22Z",
- "planned_time_window_end": "14:15:22Z",
- "location": {
- "created_using_address_book_entry_id": "string",
- "address_book_entry_reference_id": "string",
- "facility_id": "string",
- "company_name": "string",
- "identification_code": "string",
- "address": {
- "timezone": "string",
- "city": "string",
- "state_province": "string"
}, - "custom_data": { }
}, - "custom_data": { },
- "planning_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}, - "instructions": "string",
- "internal_notes": "string",
- "sequence_number": 0
}
], - "line_items": [
- {
- "id": "string",
- "total_packages": 0,
- "package_type": "PLT",
- "product_ref": "string",
- "product_category": "string",
- "stackable": true,
- "hazmat_identification_number": "string",
- "total_pieces": 0,
- "package_weight": 0,
- "weight_unit": "string",
- "height": 0,
- "width": 0,
- "length": 0,
- "length_unit": "string",
- "custom_data": { },
- "description": "string",
- "formatted_description": "string"
}
], - "metadata": {
- "archived": true
}, - "mode": {
- "id": 0,
- "code": "FTL",
- "description": "string"
}, - "equipment_type": {
- "id": 0,
- "machine_readable": "DRY_VAN",
- "name": "string"
}, - "equipment_config": {
- "id": "string",
- "driver": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "phone_number": "string"
}, - "trailer": {
- "id": "string",
- "name": "string",
- "description": "string"
}, - "power_unit": {
- "id": "string",
- "name": "string",
- "description": "string"
}
}, - "relationship_to_vendor": {
- "vendor": {
- "id": "string",
- "name": "string",
- "identifying_codes": [
- {
- "type": "string",
- "value": "string"
}
]
}
}, - "reference_id": "string",
- "bol_number": "string",
- "customer_reference_number": "string",
- "pro_number": "string",
- "purchase_order_number": "string",
- "order_number": "string",
- "drayage_carrier_scac_code": "string",
- "temperature_lower_limit": 0,
- "temperature_upper_limit": 0,
- "temperature_unit": "string",
- "drayage_seal_number": "string",
- "trailer_name": "string",
- "custom_data": { },
- "related_orders": [
- {
- "order_id": "string",
- "order_number": "string",
- "order_type": "string",
- "custom_data": { }
}
], - "description": "string",
- "notes_for_carrier": "string",
- "total_weight_override": {
- "value": 0,
- "unit": "string"
}, - "total_quantity_override": 0,
- "customer": {
- "id": "string",
- "name": "string",
- "dba_name": "string"
}, - "current_carrier": {
- "id": "string",
- "name": "string",
- "dba_name": "string"
}
}
], - "orders": [
- {
- "id": "string",
- "order_number": "string",
- "order_type": "string",
- "name": "string",
- "status": "string",
- "references": [ ],
- "customer": {
- "name": "string"
}, - "supplier": {
- "name": "string"
}, - "shipping_requirements": {
- "ship_by_date": "string",
- "required_delivery_date": "string",
- "references": [ ]
}, - "ship_from": {
- "company_name": "string",
- "location_name": "string",
- "line_1": "string",
- "line_2": "string",
- "locality": "string",
- "region": "string",
- "postal_code": "string",
- "timezone": "string",
- "shipping_requirements": {
- "plan_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
}, - "ship_to": {
- "company_name": "string",
- "location_name": "string",
- "line_1": "string",
- "line_2": "string",
- "locality": "string",
- "region": "string",
- "postal_code": "string",
- "timezone": "string",
- "shipping_requirements": {
- "plan_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
}, - "items": [ ]
}
], - "matches": {
- "property1": {
- "field": "SHIPMENT_ID",
- "value": "string",
- "label": "string"
}, - "property2": {
- "field": "SHIPMENT_ID",
- "value": "string",
- "label": "string"
}
}, - "shipment_appointments": {
- "property1": [
- {
- "id": "string",
- "status": "UNSCHEDULED",
- "stop_id": "string"
}
], - "property2": [
- {
- "id": "string",
- "status": "UNSCHEDULED",
- "stop_id": "string"
}
]
}, - "incomplete": false
}