/shipper_loads/

get

https://ship.cars/api/shipper_loads/

Retrieves a list of loads. Available only to shippers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

late

string

enum

Returns only loads that should have already been picked up or delivered (based on the estimated pickup and delivery dates).

Allowed:

resolution

string

enum

Returns only loads that match the specified load resolution.

Allowed:

active_revision__isnull

boolean

Returns only loads that match the specified active revision state.

invoice_after

date-time

Returns only loads for which the invoice is generated after the specified time.

invoice_before

date-time

Returns only loads for which the invoice is generated before the specified time.

pickup_zip

string

Returns only loads with a pickup location within the area of the specified zip code.

delivery_zip

string

Returns only loads with a delivery location within the area of the specified zip code.

inoperable

boolean

Returns only loads with vehicles that match the specified condition.

enclosed_trailer

boolean

Returns only loads that match the specified car carrier trailer requirement.

payment_type

string

enum

Returns only loads that match the specified payment method.

Allowed:

number_vehicles

integer

Returns only loads that match the specified minimum number of vehicles.

ship_within

integer

Returns only loads that are due for shipping within the specified minimum number of days.

shipper_load_id

string

Returns the load that matches the specified shipper's load ID.

update_time

date-time

Returns only loads that are last updated at the specified time.

update_time__gt

date-time

Returns only loads that are last updated after the specified time.

string

Returns only loads that match the specified search term.

ordering

string

Specifies the resource field to use for ordering the results.

limit

integer

Specifies the maximum number of results to return per page. Combine with offset for pagination.

offset

integer

Specifies the number of results to skip in the response. Combine with limit for pagination.

Headers

Authorization

string

required

Authenticates API requests with a valid access token.

Responses

200Success

401Unauthorized

403Forbidden