---
title: "NegotiationCollection"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-offer-api-1-0-0/versions/43981ece-e7be-4c4b-a45e-0f4da174a60c/schemas/NegotiationCollection"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-offer-api-1-0-0/versions/43981ece-e7be-4c4b-a45e-0f4da174a60c.md

# NegotiationCollection

A collection of negotiations.

## 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
components:
  schemas:
    Negotiation:
      type: object
      properties:
        href:
          type: string
          description: The fully qualified URL of the listing.
          example: https://example.server/examples/id/12345
        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: 157a16f0-503d-4256-ba60-a4876e8eb9bb
        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.
          nullable: true
          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/NegotiationTransaction"
          description: A collection of negotiation transactions.
      description: Details of a negotiation including its transactions.
    NegotiationTransaction:
      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: d71b5750-e89b-12d3-a456-426614174000
        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
      description: Details of a transaction within a negotiation.
    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
    NegotiationCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: "#/components/schemas/Negotiation"
          description: A collection of records.
        count:
          type: integer
          description: The total count of resources in the collection.
          format: int32
          example: 23
        href:
          type: string
          description: The URL used to query the current collection of the resource.
          example: https://prod-offers-api.awscal2.manheim.com/negotiations/mine
      description: A collection of negotiations.
```