---
title: "CreateDispatchFromCanceledDispatchRequest"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/CreateDispatchFromCanceledDispatchRequest"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md

# CreateDispatchFromCanceledDispatchRequest

Details of model for creating a dispatch request from an existing dispatch.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Fulfillment API
  version: 1.0.0
servers:
  - url: https://fulfillment-api.centraldispatch.com
    description: Production server
components:
  schemas:
    CreateDispatchFromCanceledDispatchPriceRequest:
      type: object
      properties:
        total:
          minimum: 0.01
          type: number
          description: The total amount to be paid for completing the dispatch.
          format: double
          example: 500
        currency:
          type: string
          description: The currency of `total`.
          default: USD
          nullable: true
          example: USD
        cod:
          $ref: "#/components/schemas/CodRequest"
        balance:
          $ref: "#/components/schemas/BalanceRequest"
      description: Details of dispatch price.
    AdditionalInformationRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the additional information.
          example: contractedCarrier
        value:
          type: string
          description: The value of the additional information.
          example: "true"
      description: Details of additional information.
    CodRequest:
      type: object
      properties:
        amount:
          minimum: 0
          type: number
          description: The cash on delivery (COD) or cash on pick up (COP) amount due.
          format: double
          example: 200
        paymentMethod:
          enum:
            - CHECK
            - CASH_CERTIFIED_FUNDS
          type: string
          description: The method for the COD/COP payment. Required if `amount` is greater
            than 0. This list is not exhaustive and additional values may be
            added at any time.
          nullable: true
          example: CASH_CERTIFIED_FUNDS
        paymentLocation:
          enum:
            - PICKUP
            - DELIVERY
          type: string
          description: The location that COD/COP payment is due. Required if `amount` is
            greater than 0. This list is not exhaustive and additional values
            may be added at any time.
          nullable: true
          example: PICKUP
      description: Details of cash of delivery or cash on payment (COD/COP).
      nullable: true
    BalanceRequest:
      type: object
      properties:
        amount:
          minimum: 0.01
          type: number
          description: The balance amount that will be due after the COD/COP payment is
            applied.
          format: double
          example: 300
        paymentTime:
          enum:
            - IMMEDIATELY
            - TWO_BUSINESS_DAYS_QUICK_PAY
            - FIVE_BUSINESS_DAYS
            - TEN_BUSINESS_DAYS
            - FIFTEEN_BUSINESS_DAYS
            - THIRTY_BUSINESS_DAYS
          type: string
          description: The time frame when the balance payment is due. Required if
            `amount` is greater than 0. This list is not exhaustive and
            additional values may be added at any time.
          nullable: true
        balancePaymentTermsBeginOn:
          enum:
            - PICKUP
            - DELIVERY
            - RECEIVING_SIGNED_BOL
          type: string
          description: The terms for beginning balance payment. Required if `amount` is
            greater than 0. This list is not exhaustive and additional values
            may be added at any time.
          nullable: true
          example: PICKUP
        balancePaymentMethod:
          enum:
            - CASH
            - CERTIFIED_FUNDS
            - COMPANY_CHECK
            - COMCHEK
            - TCH
          type: string
          description: The payment method with which the balance due payment will be paid.
            Required if `amount` is greater than 0. This list is not exhaustive
            and additional values may be added at any time.
          nullable: true
          example: CASH
      description: Details of a dispatch balance.
      nullable: true
    CreateDispatchFromCanceledDispatchRequest:
      type: object
      properties:
        marketplaceId:
          type: integer
          description: "The ID of the Central Dispatch Marketplace. There are three types
            of Marketplaces:\r

            \r

            - **Public**: The public Marketplace ID is `10000`.\r

            - **Test**: Test Marketplace IDs will be provided to you by Central
            Dispatch.\r

            - **Private**: Private Marketplace IDs will be provided to you by
            Central Dispatch, if necessary."
          format: int32
          nullable: true
          example: 10000
        externalId:
          type: string
          description: An identifier managed by the user. Shippers can use this field to
            map a record (e.g. order, shipment, dispatch) in their local TMS to
            a Central Dispatch record. This value is displayed as the load
            number on the Central Dispatch website.
          nullable: true
          example: RND10 CHEV
        externalOrderId:
          type: string
          description: The identifier of the order that created the dispatch in the
            shipper system managed by the user. This value is not visible on the
            Central Dispatch website.
          nullable: true
          example: ORD-2023-0001
        carrierId:
          type: string
          description: The ID of the Central Dispatch customer chosen by the shipper to
            move cars in the dispatch. The carrier must belong to the
            Marketplace identified by the `marketplaceId` and have a tier group
            of `BROKER` or `CARRIER`.
          format: uuid
          example: 0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
        shipperRequestedPickUpDate:
          type: string
          description: The date the shipper would like the vehicle to be picked up, in
            UTC/ISO 8601 format.
          format: date-time
          example: 2025-07-15T00:00:00.000Z
        shipperRequestedDropOffDate:
          type: string
          description: The date the shipper would like the vehicle to be picked up, in
            UTC/ISO 8601 format.
          format: date-time
          example: 2025-08-15T00:00:00.000Z
        price:
          $ref: "#/components/schemas/CreateDispatchFromCanceledDispatchPriceRequest"
        instructions:
          type: string
          description: "Displayed in Central Dispatch website/app as \"Load-Specific
            Terms\", these are provisions added to a contract that specify extra
            obligations, rights, or conditions beyond the standard terms.\r

            <b>Real Life Example</b>: Charging cables need to be picked up with
            vehicles and if left behind a $200 fee will be applied.\r

            <b>Rules</b>: This information will be visible only to the assigned
            carrier after the load is dispatched, and it will no longer be
            editable at that point."
          nullable: true
          example: Charging cables need to be picked up with vehicles and if left behind a
            $200 fee will be applied.
        preDispatchNotes:
          type: string
          description: "Provides general preparation instructions for shipments. This
            should not contain sensitive data as it is made available prior to
            acceptance of terms by a carrier.\r

            <b>Rules</b>: This information will always be visible to carriers,
            and it will no longer be editable once the load is dispatched."
          nullable: true
          example: In order to pick up the keys you will have to walk through a lot with a
            big dog that protects it, he's chained but will bark at you.
        transportationReleaseNotes:
          type: string
          description: "Displayed in Central Dispatch website/app as \"Transport Special
            Instructions\", these are specific guidelines or details for the
            safe and efficient pick up, delivery, or transportation of a load.
            This may contain sensitive data and is not available prior to
            acceptance of terms by a carrier.\r

            <b>Rules</b>: This information is visible only to the assigned
            carrier after the load is dispatched and remains editable at any
            time."
          nullable: true
          example: You will need special clearance to get in the lot. Call Jean at
            303-999-1212.
        additionalInformation:
          type: array
          items:
            $ref: "#/components/schemas/AdditionalInformationRequest"
          description: Additional information.
          nullable: true
      description: Details of model for creating a dispatch request from an existing
        dispatch.
      nullable: true
```