--- title: "Get Negotiation" url: "https://stage-api-docs.centraldispatch.com/apis/stage-offer-api-1-0-0/versions/43981ece-e7be-4c4b-a45e-0f4da174a60c/operations/getNegotiation" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-offer-api-1-0-0/versions/43981ece-e7be-4c4b-a45e-0f4da174a60c.md # Get Negotiation `GET` `/negotiations/id/{negotiationId}` Operation ID: `getNegotiation` 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. ## Path parameters - `negotiationId` (string, uuid, required) - The ID of the offer negotiation record. ## Header parameters - `Accept` (string, required) - 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`. ## Responses - `200` - OK. Successful request. - `401` - Unauthorized. Authentication failed or missing. - `403` - Forbidden. The attempted action is not permitted. - `404` - Not Found. **Scenarios:** - No negotiation exists with the specified `negotiationId`. - `429` - Too Many Requests. Rate limit exceeded. - `500` - Error. - `503` - Service Unavailable. Temporary service interruption. ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Offer API version: 1.0.0 servers: - url: https://prod-offers-api.awscal2.manheim.com description: Production server paths: /negotiations/id/{negotiationId}: get: tags: - Negotiations summary: Get Negotiation description: >- 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. operationId: getNegotiation parameters: - name: negotiationId in: path description: The ID of the offer negotiation record. required: true schema: type: string format: uuid example: 7e0a1107-bf75-4e09-a8db-9c3b73b4674b - name: Accept in: header description: 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`. required: true schema: type: string example: application/vnd.coxauto.v1+json responses: "200": description: OK. Successful request. headers: Etag: description: Contains the current version of the resource and should be used for the `If-Match` header on updates. schema: type: string example: "8675300" X-CoxAuto-Media-Type: description: Contains the major version and format information. schema: type: string example: coxauto.v1; format=json content: application/json: schema: $ref: "#/components/schemas/NegotiationResponse" "401": description: Unauthorized. Authentication failed or missing. "403": description: Forbidden. The attempted action is not permitted. "404": description: |- Not Found. **Scenarios:** - No negotiation exists with the specified `negotiationId`. content: application/json: schema: $ref: "#/components/schemas/Errors" "429": description: Too Many Requests. Rate limit exceeded. "500": description: Error. content: application/json: schema: $ref: "#/components/schemas/Errors" "503": description: Service Unavailable. Temporary service interruption. security: - Bearer: [] security: - Bearer: [] components: schemas: NegotiationResponse: type: object properties: href: type: string description: 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 createdOn: type: string description: The creation date and time of the item, in UTC/ISO 8601 format. format: date-time example: 2024-10-31T00:00:00Z negotiationId: type: string description: The ID of the offer negotiation record. format: uuid example: 7e0a1107-bf75-4e09-a8db-9c3b73b4674b shipperId: type: string description: The ID of the Central Dispatch customer who is the shipper. format: uuid example: afd2fb59-b89d-4572-8f9a-e57f82a61c68 carrierId: type: string description: The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch. format: uuid example: 0ca91a43-fbee-4c05-9a6c-aa5c63888f5c listingId: type: string description: The ID of the listing. example: "42220470" expirationUtc: type: string description: The expiration date of the listing, in UTC/ISO 8601 format. format: date-time example: 2025-09-30T00:00:00.000Z transactions: type: array items: $ref: "#/components/schemas/NegotiationTransactionResponse" description: A collection of negotiation transactions. description: Details of a negotiation including its transactions. Errors: type: object properties: errors: type: array items: $ref: "#/components/schemas/Error" description: A collection of errors. nullable: true description: An error occurred, and the request could not be completed. NegotiationTransactionResponse: type: object properties: offerTransactionId: type: string description: The ID of the offer negotiation record. format: uuid example: 3fde6068-5fa2-4ae4-af16-06d65fc87dc9 amount: type: number description: The balance amount that will be due after the COD/COP payment is applied. format: double example: 300 deliveryDate: type: string description: The desired delivery date of the listing, in UTC/ISO 8601 format. format: date-time example: 2025-10-04T00:00:00.000Z pickupDate: type: string description: The date the pick up is scheduled, in UTC/ISO 8601 format. format: date-time example: 2025-09-27T00:00:00.000Z transactionType: $ref: "#/components/schemas/TransactionType" userId: type: string description: The Central Dispatch user ID. format: uuid example: 157a16f0-503d-4256-ba60-a4876e8eb9bb createdOn: type: string description: The creation date and time of the item, in UTC/ISO 8601 format. format: date-time example: 2024-10-31T00:00:00Z customerId: type: string description: The Central Dispatch customer ID of the customer. format: uuid example: d5c62b14-cbd1-11ee-9a0e-0242ac110002 description: Details of a transaction within a negotiation. Error: type: object properties: code: type: string description: The code used for the issue. nullable: true example: resource.issue_type message: type: string description: A detailed message. nullable: true example: The issue happened because something is wrong. property: type: string description: The property to which the issue is associated. nullable: true example: person properties: type: object additionalProperties: type: string description: Additional properties related to the issue. nullable: true example: firstName: D0nn@ lastName: Sm!th description: Details of an error or issue. TransactionType: enum: - ORIGINAL_ASK - INITIAL_OFFER - MODIFICATION - REJECTION - ACCEPTANCE - REACTIVATION - ARCHIVAL - SYSTEM_REJECTION - EXPIRATION - AUTO_ACCEPTANCE - REVOKED type: string description: Different types of transactions that can occur within a negotiation. This list is not exhaustive and additional values may be added at any time. example: INITIAL_OFFER securitySchemes: Bearer: type: http scheme: Bearer ```