List carrier bidding-specific information about 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

status
Array of strings

Include shipments with these statuses

Items Enum: "appointment_pending" "at_pickup" "at_delivery" "auction_running" "cancelled" "carrier_confirmed" "delayed" "delivered" "dispatched" "draft" "in_transit" "out_for_delivery" "quote_accepted" "quoting" "reconciled" "scheduled" "tendered"
open
boolean

Filter on whether or not a shipment is open

Responses
200

Paginated list of shipment carrier bidding summaries

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

Default error response

get/quoting/carrier-bids/shipment-summary/
Request samples
Response samples
application/json
{
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}
Copyright © Shipwell 2024. All right reserved.