List all SpotNegotiations in which the user's company is involved

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

closed_by_customer
boolean

Restrict SpotNegotiations based on whether customer closed

closed_by_vendor
boolean

Restrict SpotNegotiations based on whether vendor closed

customer_id
string <uuid>

ID of customer company to which to restrict SpotNegotiations

customer_name__contains
string

Partial name of customer company to which to restrict SpotNegotiations

involved_only
boolean

Restrict SpotNegotiations to those in which user is explicitly involved

involved_vendor_users
Array of strings <uuid>

Restrict SpotNegotiations to those with provided User IDs involved on the vendor side

is_most_recent_winner
boolean

Restrict SpotNegotiations to those that are or are not the most recent winner

is_open
boolean

Restrict SpotNegotiations based on both sides agreeing the negotiation is open

shipment
string <uuid>

Return SpotNegotiations where Shipment ID matches

shipment_bol_number
string

Return SpotNegotiations where Shipment BOL number matches

shipment_bol_number__contains
string

Return SpotNegotiations where Shipment BOL number partially matches

shipment_capacity_provider_customer_reference_number
string

Return SpotNegotiations where Shipment capacity provider customer reference number matches

shipment_capacity_provider_customer_reference_number__contains
string

Return SpotNegotiations where Shipment capacity provider customer reference number partially matches

shipment_customer_reference_number
string

Return SpotNegotiations where Shipment customer reference number matches

shipment_customer_reference_number__contains
string

Return SpotNegotiations where Shipment customer reference number partially matches

shipment_delayed
string

Return SpotNegotiations where Shipment delayed matches

shipment_destination__contains
string

Return SpotNegotiations where Shipment destination partially matches

shipment_dropoff__gte
string <date>

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

shipment_dropoff__lte
string <date>

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

shipment_name
string

Return SpotNegotiations where Shipment name matches

shipment_name__contains
string

Return SpotNegotiations where Shipment name partially matches

shipment_origin__contains
string

Return SpotNegotiations where Shipment origin partially matches

shipment_pickup__gte
string <date>

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

shipment_pickup__lte
string <date>

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

shipment_pickup_number
string

Return SpotNegotiations where Shipment pickup number matches

shipment_pickup_number__contains
string

Return SpotNegotiations where Shipment pickup number partially matches

shipment_pro_number
string

Return SpotNegotiations where Shipment PRO number matches

shipment_pro_number__contains
string

Return SpotNegotiations where Shipment PRO number partially matches

shipment_purchase_order_number
string

Return SpotNegotiations where Shipment purchase order number matches

shipment_purchase_order_number__contains
string

Return SpotNegotiations where Shipment purchase order number partially matches

shipment_reference_id
string

Return SpotNegotiations where Shipment reference_id matches

shipment_reference_id__contains
string

Return SpotNegotiations where Shipment reference_id partially matches

shipment_state
string

Return SpotNegotiations where Shipment state matches

shipment_status
Array of strings

Return SpotNegotiations with shipments that have provided 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"
vendor_id
string <uuid>

ID of the vendor company to which to restrict SpotNegotiations

vendor_name__contains
string

Partial name of the vendor company to which to restrict SpotNegotiations

expand_quotes
integer

Boolean, if True will include quotes

Responses
200

List of SpotNegotiations with shipments expanded

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

Default error response

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