# List LTL shipments by Order Numbers and Rate Numbers

This endpoint allows you to list LTL shipments by Order Numbers and Rate Numbers. Max 50 order numbers can be passed. Order numbers should be comma separated.

Endpoint: GET /api/ltl/shipments
Version: 1.0.0
Security: bearerAuth

## Query parameters:

  - `order_numbers` (string)
    A list of order numbers separated by commas. Max 50 order numbers can be passed.
    Example: "123,456,789"

  - `rate_numbers` (string)
    A list of rate numbers separated by commas. Max 50 rate numbers can be passed.
    Example: "R123,R456,R789"

## Response 201 fields (application/json):

  - `data` (array)

  - `data.order_number` (string, required)
    Example: "LS241205028749"

  - `data.pickup_company_name` (string, required)
    Example: "Pickup Company"

  - `data.pickup_contact_name` (string, required)
    Example: "John Doe"

  - `data.pickup_contact_phone` (string, required)
    Example: "123-456-7890"

  - `data.pickup_contact_email` (string, required)
    Example: "pickup@example.com"

  - `data.pickup_zipcode` (string, required)
    Example: "90047"

  - `data.pickup_city` (object, required)

  - `data.pickup_city.id` (integer)
    Example: 1

  - `data.pickup_city.name` (string)
    Example: "New York"

  - `data.pickup_city.alias` (string)
    Example: "NY"

  - `data.pickup_city.state` (string)
    Example: "New York"

  - `data.pickup_city.country` (string)
    Example: "US"

  - `data.pickup_city.latitude` (number)
    Example: 40.712776

  - `data.pickup_city.longitude` (number)
    Example: -74.005974

  - `data.pickup_city.full_name` (string)
    Example: "New York, NY, US"

  - `data.pickup_address1` (string, required)
    Example: "123 Main St"

  - `data.pickup_address2` (string,null)
    Example: "Apt 4B"

  - `data.destination_company_name` (string, required)
    Example: "Destination Company"

  - `data.destination_contact_name` (string, required)
    Example: "Jane Doe"

  - `data.destination_contact_phone` (string, required)
    Example: "987-654-3210"

  - `data.destination_contact_email` (string, required)
    Example: "destination@example.com"

  - `data.destination_zipcode` (string, required)
    Example: "92404"

  - `data.destination_city` (object, required)

  - `data.destination_address1` (string, required)
    Example: "456 Elm St"

  - `data.destination_address2` (string,null)
    Example: "Suite 5"

  - `data.pro_number` (string)
    Example: "PRO123456789"

  - `data.pickup_accessorials` (array)

  - `data.destination_accessorials` (array)

  - `data.pickup_special_request` (string)
    Example: "Special request"

  - `data.destination_special_request` (string)
    Example: "Special request"

  - `data.pickup_number` (string)
    Example: "123"

  - `data.dropoff_number` (string)
    Example: "123"

  - `data.customer_reference_number` (string)
    Example: "REF123"

  - `data.customer_status` (string)
    Example: "Pending"

  - `data.rate` (number, required)
    Example: 2482.04

  - `data.cargo_value` (number, required)
    Example: 1221

  - `data.premium` (number)
    Example: 1221

  - `data.is_insurance_entrusted` (boolean, required)
    Example: true

  - `data.pickup_open_time` (string, required)
    Example: "08:00"

  - `data.pickup_close_time` (string, required)
    Example: "18:00"

  - `data.estimated_pickup_date` (string, required)
    Example: "2024-12-31"

  - `data.actual_pickup_date` (string)
    Example: "2024-12-31"

  - `data.estimated_delivery_date` (string, required)
    Example: "2025-01-31"

  - `data.actual_delivery_date` (string)
    Example: "2025-01-31"

  - `data.destination_open_time` (string, required)
    Example: "09:00"

  - `data.destination_close_time` (string, required)
    Example: "18:00"

  - `data.items` (array, required)
    Array of items to be shipped

  - `data.items.weight_unit` (string, required)
    Enum: "lbs", "kg"

  - `data.items.dimension_unit` (string, required)
    Enum: "in", "cm"

  - `data.items.height` (integer, required)
    Example: 72

  - `data.items.length` (integer, required)
    Example: 48

  - `data.items.width` (integer, required)
    Example: 40

  - `data.items.total_weight` (integer, required)
    Example: 1200

  - `data.items.units` (integer, required)
    Example: 1

  - `data.items.pieces` (integer,null)
    Required when home delivery is not selected. Optional when home delivery is selected.
    Example: 1

  - `data.items.package_type` (string, required)
    Enum: "Bag", "Bale", "Box", "Bucket", "Bundle", "Can", "Carton", "Case", "Coil", "Crate", "Cylinder", "Drums", "Pail", "Pieces", "Pallet", "Reel", "Roll", "Skid", "Tube", "Tote"

  - `data.items.description` (string, required)
    Description of the item
    Example: "general goods"

  - `data.documents` (array)

  - `data.documents.file_name` (string)
    Example: "document.pdf"

  - `data.documents.document_type` (string)
    Example: "BOL"

  - `data.documents.document_url` (string)
    Example: "https://example.com/document.pdf"

  - `data.created_at` (string)
    Example: "2024-12-05 02:44"

## Response 400 fields (application/json):

  - `message` (string)
    Example: "INVALID REQUEST."

## Response 401 fields (application/json):

  - `message` (string)
    Example: "Unauthenticated."

## Response 500 fields (application/json):

  - `message` (string)
    Example: "Internal server error"