Search shipments and orders matching an exact reference value at a given facility.
Successful Response
required | Array of objects (Shipments) |
required | Array of objects (Orders) |
object (Shipment Appointments) Per matched shipment id, its appointments at the searched facility. Every matched shipment has an entry; an empty list means it has no appointment here. |
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": [ ]
}
], - "shipment_appointments": {
- "property1": [
- {
- "id": "string",
- "status": "TEMP_DRAFT",
- "stop_id": "string"
}
], - "property2": [
- {
- "id": "string",
- "status": "TEMP_DRAFT",
- "stop_id": "string"
}
]
}
}