Get a list of shipments

SecurityAuthToken
Request
query Parameters
page
integer

indicates what page of a list of query results you want to view

page-size
integer

indicates the how many items to return per page in a list request

ordering
string

Determines which column to sort by. Prepend with '-' to sort desc.

q
string

search query

active_vendor_assignment
boolean

Include or exclude shipments with active CarrierAssignments

alert_types
string

Filter on shipments that have alerts of this type

Enum: "MOBILE_DEVICE_ALERT" "NON_ACTIVE_CARRIER"
alerts
boolean

Filter on whether or not a Shipment has alert messages

archived
boolean

Filter on whether or not a shipment is archived

bol_number
Array of strings

Include shipments with these BOL Numbers

bol_number__contains
string

Return shipments where the BOL number contains this value

bol_number__exclude
Array of strings

Exclude shipments with these BOL Numbers

created_at
string <date-time>

For requesting data created at a certain datetime

created_by_source
Array of strings

Return shipments created by sources in the array.

Items Enum: "SHIPWELL_WEB" "IMPORT" "TENDER" "SHIPWELL_WEB_UNAUTH" "OTHER"
created_by_user__contains
string

Return shipments where created_by_user object contains this string e.g first_name, last_name or email

created_by_user_id
Array of strings <uuid>

Return shipments where created_by_user_id in the array.

created_by_user_name
string

Return shipments where created_by_user_name is exactly this string

created_by_user_name__contains
string

Return shipments where created_by_user_name contains this string

customer
string

Return shipments with this exact value as the customer company name

customer__contains
string

Return shipments where the customer company name contains this value

customer_id
string <uuid>

Return shipments with this exact id for the customer company

customer_reference_number
Array of strings

Include shipments with these Customer Reference Numbers

customer_reference_number__contains
string

Include shipments where the Customer Reference Numbers contains this value

customer_reference_number__exclude
Array of strings

Exclude shipments with these Customer Reference Numbers

destination__contains
string

Return shipments with this value in the destination

string or Array of strings

Return shipments with this value in one of its dropoff stops. Supports multiple values.

string or Array of strings

Return shipments with this value in one of its delivery stops location company_name. Supports multiple values.

destination_state_province
string

Return shipments with this state province on its destination stop

delivery_stops_state_province
string

Return shipments with this state province on its delivery stops

drayage_booking_number__contains
string

Include shipments where the drayage booking number contains this value

drayage_chassis_number__contains
string

Include shipments where the drayage chassis number contains this value

drayage_container_number__contains
string

Include shipments where the drayage container number contains this value

drayage_container_return_date__gte
string

Include shipments where the drayage container return date is greater than or equal to this value

drayage_container_return_date__lte
string

Include shipments where the drayage container return date is less than or equal to this value

drayage_estimated_arrival_date__gte
string

Include shipments where the drayage estimated arrival date is greater than or equal to this value

drayage_estimated_arrival_date__lte
string

Include shipments where the drayage estimated arrival date is less than or equal to this value

drayage_last_free_date__gte
string

Include shipments where the drayage last free datetime is greater than or equal to this value

drayage_last_free_date__lte
string

Include shipments where the drayage last free datetime is less than or equal to this value

drayage_release_date__gte
string

Include shipments where the drayage release datetime is greater than or equal to this value

drayage_release_date__lte
string

Include shipments where the drayage release datetime is less than or equal to this value

drayage_seal_number__contains
string

Include shipments where the drayage seal number contains this value

driver_assigned
boolean

Return shipments where the driver is assigned/unassigned

dropoff__gte
string <date>

Return shipments with a dropoff stop with a planned date greater than or equal to this value

dropoff__lte
string <date>

Return shipments with a dropoff stop with a planned data less than or equal to this value

equipment_type
string

Return shipments with this equipment type

equipment_type__contains
string

Return shipments where the equipment type contains this value

fedex_account
string

Return pickups specific to this FedEx account

groupId
string

Group id for a shipment

groups
Array of strings

Filter shipments by group_id (UUID). Supports multiple values for OR logic.

groups__exclude
Array of strings

Exclude shipments by group_id (UUID). Supports multiple values.

groups_external_ids
Array of strings

Filter shipments by group external_id (human-readable string). Supports multiple values for OR logic.

groups_external_ids__exclude
Array of strings

Exclude shipments by group external_id (human-readable string). Supports multiple values.

has_invoice
boolean

If true, show shipments which have at least one invoice otherwise show those with none.

has_bill
boolean

If true, show shipments which have at least one bill otherwise show those with none.

include
Array of strings

[v3] A list of properties to include in the response resource

load_board_enabled
boolean

Filter on whether or not a shipment is posted on the company load board

load_board_id
string

Return shipments where the load board ID is equal to this value

load_board_id__contains
string

Return shipments where the load board ID contains this value

mode
string

Return shipments with this shipment mode

mode__contains
string

Return shipments where the shipment mode contains this value

name__contains
string

Return shipments where the shipment name contains this value

open
boolean

Filter on whether or not a shipment is open

origin__contains
string

Return shipments with this value in the origin

origin_state_province
string

Return shipments with this state province on its origin stop

pickup_stops_state_province
string

Return shipments with this state province on its pickup stops

string or Array of strings

Return shipments with this value in one of its pickup stops. Supports multiple values.

string or Array of strings

Return shipments with this value in one of its pickup stops location company_name. Supports multiple values.

parcel_pickup_status
Array of strings

Include shipments where the parcel pickup status equals one of these values

Items Enum: "CANCELLED" "DELAYED" "DELIVERED" "IN_TRANSIT" "NOT_SCHEDULED" "SCHEDULED"
pickup__gte
string <date>

Return shipments with a pickup stop with a planned date greater than or equal to this value

updated_at__gte
string <datetime>

Return shipments updated greater than or equal to this value

updated_at__lte
string <datetime>

Return shipments updated less than or equal to this value

pickup__lte
string <date>

Return shipments with a pickup stop with a planned date less than or equal to this value

pickup_id
string <uuid>

Include shipments currently associated with the provided ShipmentPickup's ID

pickup_number
Array of strings

Include shipments with these Pickup Numbers

pickup_number__contains
string

Include shipments where the Pickup Number contains this value

pickup_number__exclude
Array of strings

Exclude shipments with these Pickup Numbers

pro_number
Array of strings

Include shipments with these PRO Numbers

pro_number__contains
string

Return shipments where the PRO number contains this value

pro_number__exclude
Array of strings

Exclude shipments with these PRO Numbers

power_unit
string <uuid>

Return shipments where this power unit is assigned

purchase_order_number
Array of strings

Include shipments with these PO Numbers

purchase_order_number__contains
string

Include shipments where the PO number contains this value

purchase_order_number__exclude
Array of strings

Exclude shipments with these PO Numbers

reference_id
Array of strings

Include shipments with these Reference IDs

reference_id__contains
string

Include shipments where the reference ID contains this value

reference_id__exclude
Array of strings

Exclude shipments with these Reference IDs

master_air_waybill
Array of strings

Include shipments with these Master Air Waybill Numbers

master_air_waybill__contains
string

Include shipments where the Master Air Waybill number contains this value

house_air_waybill
Array of strings

Include shipments with these House Air Waybill Numbers

house_air_waybill__contains
string

Include shipments where the House Air Waybill number contains this value

reps
Array of strings <uuid>

Include shipments with these reps

role
string

Get results based on a specific perspective such as owner_operator

Value: "owner_operator"
service_level
string

Return shipments with this service level

accessorials
Array of strings

Include only shipments with at least one matching ShipmentAccessorial

created_at__gte
string <date-time>

Include shipments where created_at is greater than or equal to the time value

created_at__lte
string <date-time>

Include shipments where created_at is less than or equal to this value

status
Array of strings

Include shipments with these statuses

Items Enum: "appointment_pending" "arrived_at_rail_facility" "at_delivery" "at_destination_airport" "at_destination_port" "at_origin_airport" "at_origin_port" "at_pickup" "auction_running" "available" "available_at_offdock_facility" "available_at_rail_facility" "barge_berthed_at_destination" "barge_berthed_at_origin_port" "barge_departed_from_destination_port" "barge_departed_from_origin" "cancelled" "carrier_confirmed" "cleared_customs" "customs_hold" "customs_review" "delayed" "delivered" "departed_on_rail" "discharged" "discharged_at_transshipment_port" "discharged_from_barge_at_destination" "discharged_from_barge_at_origin_port" "dispatched" "draft" "empty_dropped_off_at_trucker_yard" "empty_outgated" "empty_picked_up_for_return" "empty_picked_up_from_trucker_yard" "empty_ready_for_pickup" "empty_returned" "exception" "full_dropped_off_at_trucker_yard" "full_ingated" "full_ingated_to_offdock_facility" "full_outgated" "full_outgated_from_offdock_facility" "full_outgated_from_rail_facility" "full_picked_up_from_trucker_yard" "in_transit" "loaded" "loaded_at_transshipment_port" "loaded_on_barge_at_destination_port" "loaded_on_barge_at_origin" "loaded_on_rail" "out_for_delivery" "quote_accepted" "quoting" "reconciled" "scheduled" "tendered" "vessel_arrived" "vessel_arrived_at_transshipment_port" "vessel_berthed" "vessel_berthed_at_transshipment_port" "vessel_departed" "vessel_departed_from_transshipment_port"
status__exclude
Array of strings

Exclude shipments with these statuses

Items Enum: "appointment_pending" "arrived_at_rail_facility" "at_delivery" "at_destination_airport" "at_destination_port" "at_origin_airport" "at_origin_port" "at_pickup" "auction_running" "available" "available_at_offdock_facility" "available_at_rail_facility" "barge_berthed_at_destination" "barge_berthed_at_origin_port" "barge_departed_from_destination_port" "barge_departed_from_origin" "cancelled" "carrier_confirmed" "cleared_customs" "customs_hold" "customs_review" "delayed" "delivered" "departed_on_rail" "discharged" "discharged_at_transshipment_port" "discharged_from_barge_at_destination" "discharged_from_barge_at_origin_port" "dispatched" "draft" "empty_dropped_off_at_trucker_yard" "empty_outgated" "empty_picked_up_for_return" "empty_picked_up_from_trucker_yard" "empty_ready_for_pickup" "empty_returned" "exception" "full_dropped_off_at_trucker_yard" "full_ingated" "full_ingated_to_offdock_facility" "full_outgated" "full_outgated_from_offdock_facility" "full_outgated_from_rail_facility" "full_picked_up_from_trucker_yard" "in_transit" "loaded" "loaded_at_transshipment_port" "loaded_on_barge_at_destination_port" "loaded_on_barge_at_origin" "loaded_on_rail" "out_for_delivery" "quote_accepted" "quoting" "reconciled" "scheduled" "tendered" "vessel_arrived" "vessel_arrived_at_transshipment_port" "vessel_berthed" "vessel_berthed_at_transshipment_port" "vessel_departed" "vessel_departed_from_transshipment_port"
status__contains
string

Include shipments where the status contains this string

tags
Array of strings <uuid>

Include only shipments with at least one matching ShipmentTag

tags__exclude
Array of strings <uuid>

Excludes shipments with at least one matching tag

shipment_shipwell_custom_data
Array of strings

Include shipments that contain these shipment-level custom data values

stops__contains
string

Return shipments with this value in one of its stops

stops_company_name__contains
string

Return shipments with this value in one of its stops location company_name

stops_state_province
string

Return shipments with this state province on one of its stops

timeline_last_updated_at__gte
string

Return shipments where last timeline update was greater than or equal to the value or was never updated

timeline_last_updated_at__lte
string

Return shipments where last timeline update was less than or equal to the value or was never updated

time_frame
string

Return shipments that are within the given time frame. active = current + upcoming

Enum: "current" "upcoming" "active" "past"
total_miles__gte
integer

Return shipments with total miles greater than or equal to this value

total_miles__lte
integer

Return shipments with total miles less than or equal to this value

ups_account
string

Return pickups specific to this UPS account

vendor_id
string

Return shipments with this exact value as the vendor Carrier id

vendor__contains
string

Return shipments where the vendor company name contains this value

total_weight_override__gte
integer

Return shipments with weight greater than or equal to this value

total_weight_override__lte
integer

Return shipments with weight less than or equal to this value

origin_radius
integer

Radius from origin stop

origin_lat
number <float>

Latitude of location to filter on for origin stop

origin_lon
number <float>

Longitude of location to filter on for origin stop

pickup_radius
integer

Radius from a pickup stop

pickup_lat
number <float>

Latitude of location to filter on for pickup stop

pickup_lon
number <float>

Longitude of location to filter on for pickup stop

destination_radius
integer

Radius from the destination stop

destination_lat
number <float>

Latitude of location to filter on for destination stop

destination_lon
number <float>

Longitude of location to filter on for destination stop

delivery_radius
integer

Radius from a delivery stop

delivery_lat
number <float>

Latitude of location to filter on for delivery stop

delivery_lon
number <float>

Longitude of location to filter on for delivery stop

workflow_execution_status
Array of strings

Include shipments with these workflow execution statuses

Items Enum: "RUNNING" "CANCELLED" "FAILED" "SUCCESS"
show_cloned_results
boolean

If true, show shipments that have a non null last_cloned_at value

header Parameters
X-Company-Id
string

allows request to retrieve information about the company given in the header instead of the company associated with the requesting user

Responses
200

Successfully returned a list of Shipments

Response Schema: application/json
page_size
integer
Array of objects (SlimShipment)
total_count
integer
total_pages
integer
default

Default error response

get/shipments/
Request samples 
Response samples 
application/json
{
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}
Copyright © Shipwell 2025. All right reserved.