Offer API

Errors

object

An error occurred, and the request could not be completed.

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example

InitiateNegotiationModel

object

Details of a negotiation.

listingIdstring

The ID of the listing.

Example:42220470

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

Example

Negotiation

object

Details of a negotiation including its transactions.

hrefstring

The fully qualified URL of the listing.

Example:https://example.server/examples/id/12345

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:157a16f0-503d-4256-ba60-a4876e8eb9bb

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
Example

NegotiationCollection

object

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

Example

NegotiationResponse

object

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
Example