Stage - Offer API

Offer API

Get Negotiation

Get offer negotiation details.

📝 Important Notes

  • The ID of the resource is returned in resource’s create endpoint. The response will contain a Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.
  • The response will include an ETag header, which should be used for the If-Match header in subsequent updates.
get
https://prod-offers-api.awscal2.manheim.com/negotiations/id/{negotiationId}

Path Parameters

negotiationIdstring(uuid)required

The ID of the offer negotiation record.

Example:7e0a1107-bf75-4e09-a8db-9c3b73b4674b

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

OK. 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
get/negotiations/id/{negotiationId}
 
application/json

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

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

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

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

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.

🎯 Preferred Carrier Offers

A Preferred Carrier Offer is one made on a listing that is:

  • A V2 listing (listingId >= 300000000).
  • Linked to a single Public Marketplace.
  • Non-searchable (not shown on the load board).

Adjustments to such an offer are re-validated against the same price and expiration constraints enforced at creation, on every adjustment:

  • amount must exactly equal the listing’s price.total — no other value is accepted.
  • expirationDateTime must not exceed the listing’s expirationDate, if one is set.
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

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

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

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

Accepted. Successful request.

post/negotiations/id/{negotiationId}/declineOffer
 

Revoke an Offer

Revokes an offer on a listing that is still awaiting a response. This includes a shipper revoking a Preferred Carrier Offer sent to a specific carrier in their preferred network.

📝 Important Notes

  • Revoke requires the listing to be a V2 listing (listingId >= 300000000) linked to a single Public Marketplace (marketplaceId 10000).
  • For a Preferred Carrier Offer, only a shipper with an active Premium Dealer/Broker subscription in the Public Marketplace may revoke.
  • Revoke is only valid while the offer is awaiting carrier response (AWAITING_CARRIER); it cannot be used once the offer has already been ACCEPTED, DECLINED, or REVOKED.
post
https://prod-offers-api.awscal2.manheim.com/negotiations/id/{negotiationId}/revoke

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

Accepted. Successful request.

post/negotiations/id/{negotiationId}/revoke