Search
K
Offer API

Offer API

1.0.0OAS 3.0

Central Dispatch’s Offer API allows shippers and brokers to manage offers made to carriers for listings. This API provides functionalities for creating, updating, and retrieving offers, ensuring that shippers and brokers can efficiently handle the negotiation and acceptance processes.
🔑 Scope: offers_api

API Base URL
  • Server 1:https://prod-offers-api.awscal2.manheim.com

    Production server

Security
Bearer (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Additional Information
Contact (datasyndicationsupport@centraldispatch.com)

Start Negotiation

Initiate an offer negotiation on a listing.

📝 Important Notes

  • 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.
post
https://prod-offers-api.awscal2.manheim.com/negotiations

Headers

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

InitiateNegotiationModel

InitiateNegotiationModel

Details of a negotiation.

listingIdstring

The ID of the listing.

Example:42220470

carrierIdstring | null(uuid)

The ID of the Central Dispatch customer the shipper wants to move cars in the dispatch. If a shipper is making the offer this is required.

Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c

amountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

>= 0

Example:300

pickupDatestring | null(date-time)

The date the pick up is scheduled, in UTC/ISO 8601 format… Will default to the listing pick up date if not specified.

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

deliveryDatestring | null(date-time)

The desired delivery date of the listing, in UTC/ISO 8601 format. Will default to the listing delivery date if not specified.

Example:2025-10-04T00:00:00.000Z

marketplaceIdinteger(int32)

The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:

  • Public: The public Marketplace ID is 10000.
  • Test: Test Marketplace IDs will be provided to you by Central Dispatch.
  • Private: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.

Example:10000

expirationDateTimestring(date-time)

The expiration date of the listing, in UTC/ISO 8601 format.

Example:2025-11-20T00:00:00.000Z

Response

Created. Successful request.

post/negotiations

Body

{ "amount": 300, "carrierId": "0ca91a43-fbee-4c05-9a6c-aa5c63888f5c", "deliveryDate": "2025-10-04T00:00:00.000Z", "expirationDateTime": "2025-11-20T00:00:00.000Z", "listingId": "42220470", "marketplaceId": 10000, "pickupDate": "2025-09-27T00:00:00.000Z" }
 

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