Stage - Offer API

Offer API

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
 

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.

  • startingPoint is 1-based integer, default 1.
  • numberOfResults is 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

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
 
application/json

AcceptOfferRequest

object

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

Example

AdjustOfferRequest

object

Details of an offer adjustment request.

amountnumber(double)

The updated amount for the offer.

>= 0

Example:300

pickupDatestring(date-time)

The offered date of the pick up, in UTC/ISO 8601 format.

Example:2025-09-27T00:00:00.000Z

deliveryDatestring(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

Example

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

messagestring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example