negotiationIdstring(uuid)required
The ID of the offer negotiation record.
Example:7e0a1107-bf75-4e09-a8db-9c3b73b4674b
Accept Offer
Accept an offer.
📝 Important Notes
Acceptance of an offer can only be done by the party who was not the last one to transact on the offer.
post
https://prod-offers-api.awscal2.manheim.com/negotiations/id/{negotiationId}/acceptOffer
Path Parameters
Headers
If-Matchintegerrequired
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
Content-Typestringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Body
application/json
Body
application/json
AcceptOfferRequest
AcceptOfferRequest
Details of an offer accept request.
pickupDatestring(date-time)required
The accepted date of the pick up, in UTC/ISO 8601 format…
Example:2025-09-27T00:00:00.000Z
deliveryDatestring(date-time)required
The accepted date of the delivery, in UTC/ISO 8601 format…
Example:2025-10-04T00:00:00.000Z
Response
application/json
Response
application/json
Accepted. Successful request.
NegotiationResponse
Details of a negotiation including its transactions.
hrefstring
The URL used to query the current collection of the resource.
Example:https://prod-offers-api.awscal2.manheim.com/negotiations/7e0a1107-bf75-4e09-a8db-9c3b73b4674b
createdOnstring(date-time)
The creation date and time of the item, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
negotiationIdstring(uuid)
The ID of the offer negotiation record.
Example:7e0a1107-bf75-4e09-a8db-9c3b73b4674b
shipperIdstring(uuid)
The ID of the Central Dispatch customer who is the shipper.
Example:afd2fb59-b89d-4572-8f9a-e57f82a61c68
carrierIdstring(uuid)
The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
listingIdstring
The ID of the listing.
Example:42220470
expirationUtcstring(date-time)
The expiration date of the listing, in UTC/ISO 8601 format.
Example:2025-09-30T00:00:00.000Z
transactionsarray[object]
Details of a transaction within a negotiation.
Show Child Parameters
post/negotiations/id/{negotiationId}/acceptOffer
Authentication
Path Parameters
Headers
Body
{
"pickupDate": "2025-09-27T00:00:00.000Z",
"deliveryDate": "2025-10-04T00:00:00.000Z"
}
application/json
Adjust Offer
Adjusts an offer on a listing.
📝 Important Notes
Adjustments of an offer can only be done by the party who was not the last one to transact on the offer.
post
https://prod-offers-api.awscal2.manheim.com/negotiations/id/{negotiationId}/appendAdjustment
Path Parameters
negotiationIdstring(uuid)required
The ID of the offer negotiation record.
Example:7e0a1107-bf75-4e09-a8db-9c3b73b4674b
Headers
If-Matchintegerrequired
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
Content-Typestringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Body
application/json
Body
application/json
AdjustOfferRequest
AdjustOfferRequest
Details of an offer adjustment request.
amountnumber(double)
The updated amount for the offer.
>= 0
Example:300
pickupDatestring | null(date-time)
The offered date of the pick up, in UTC/ISO 8601 format…
Example:2025-09-27T00:00:00.000Z
deliveryDatestring | null(date-time)
The offered date of the delivery, in UTC/ISO 8601 format…
Example:2025-10-04T00:00:00.000Z
expirationDateTimestring(date-time)
The date the offer will expire, in UTC/ISO 8601 format…
Example:2025-11-20T00:00:00.000Z
Response
application/json
Response
application/json
Accepted. Successful request.
NegotiationResponse
Details of a negotiation including its transactions.
hrefstring
The URL used to query the current collection of the resource.
Example:https://prod-offers-api.awscal2.manheim.com/negotiations/7e0a1107-bf75-4e09-a8db-9c3b73b4674b
createdOnstring(date-time)
The creation date and time of the item, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
negotiationIdstring(uuid)
The ID of the offer negotiation record.
Example:7e0a1107-bf75-4e09-a8db-9c3b73b4674b
shipperIdstring(uuid)
The ID of the Central Dispatch customer who is the shipper.
Example:afd2fb59-b89d-4572-8f9a-e57f82a61c68
carrierIdstring(uuid)
The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
listingIdstring
The ID of the listing.
Example:42220470
expirationUtcstring(date-time)
The expiration date of the listing, in UTC/ISO 8601 format.
Example:2025-09-30T00:00:00.000Z
transactionsarray[object]
Details of a transaction within a negotiation.
Show Child Parameters
post/negotiations/id/{negotiationId}/appendAdjustment
Authentication
Path Parameters
Headers
Body
{
"amount": 300,
"deliveryDate": "2025-10-04T00:00:00.000Z",
"pickupDate": "2025-09-27T00:00:00.000Z",
"expirationDateTime": "2025-11-20T00:00:00.000Z"
}
application/json
Decline an Offer
Declines an offer on a listing.
📝 Important Notes
An offer can be declined only by the party who was not the last one to transact on the offer.
post
https://prod-offers-api.awscal2.manheim.com/negotiations/id/{negotiationId}/declineOffer
Path Parameters
negotiationIdstring(uuid)required
The ID of the offer negotiation record.
Example:7e0a1107-bf75-4e09-a8db-9c3b73b4674b
Headers
If-Matchintegerrequired
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
Content-Typestringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Response
Response
Accepted. Successful request.
post/negotiations/id/{negotiationId}/declineOffer
Authentication
Path Parameters
Headers
Get My Negotiations
Retrieve negotiations of current user.
📝 Important Notes
To simply query a single listingId or carrierId use standard parameters e.g., listingId=1234 or carrierId=5678.
The eq parameters can retrieve multiple and may be combined with and and or.
Example:
- eq(carrierId,123214)and(eq(listingId,1234,2345)))
- eq(carrierId,123214)or(eq(listingId,1234)))
- eq(carrierId,123214)or(eq(carrierId,9999)))
get
https://prod-offers-api.awscal2.manheim.com/negotiations/mine
Query Parameters
listingIdstring
Search for events with listing ID equal to value.
Example:42220470
eq(listingId,<listingId1>,<listingId2>)string
Search for events with listing ID equal to values.
Example:eq(listingId,42220470,43000470)
carrierIdstring
Search for events with carrier ID equal to value.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
eq(carrierId,<carrierId1>,<carrierId2>)string
Search for events with carrier ID equal to values.
Example:eq(carrierId,0ca91a43-fbee-4c05-9a6c-aa5c63888f5c,d4efb4d9-2418-4070-b2f9-46317d578a31)
limit(startingPoint,numberOfResults)string
The maximum number of items to be returned in the response.
startingPointis 1-based integer, default 1.numberOfResultsis an integer, default 100, maximum 500.
Example:limit(1,10)
Headers
Acceptstringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Response
application/json
Response
application/json
OK. Successful request.
NegotiationCollection
A collection of negotiations.
itemsarray[object]
Details of a negotiation including its transactions.
Show Child Parameters
countinteger(int32)
The total count of resources in the collection.
Example:23
hrefstring
The URL used to query the current collection of the resource.
Example:https://prod-offers-api.awscal2.manheim.com/negotiations/mine
get/negotiations/mine
Authentication
Query Parameters
Headers
application/json
AcceptOfferRequest
objectDetails of an offer accept request.
pickupDatestring(date-time)required
The accepted date of the pick up, in UTC/ISO 8601 format…
Example:2025-09-27T00:00:00.000Z
deliveryDatestring(date-time)required
The accepted date of the delivery, in UTC/ISO 8601 format…
Example:2025-10-04T00:00:00.000Z
Example