---
title: "Create Dispatch from Canceled Dispatch"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/operations/postDispatchFromCanceled"
---

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

# Create Dispatch from Canceled Dispatch

`POST` `/api/fulfillments/dispatches/ref/dispatches/id/{dispatchId}`

Operation ID: `postDispatchFromCanceled`

Create a new dispatch by copying information from a canceled dispatch. #### 👥 Customer Type - Shipper #### 📝 Important Notes - All information from the canceled dispatch will be copied to the new dispatch. - A new dispatch ID will be generated automatically. - 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

- `dispatchId` (string, uuid, required) - The ID of the canceled dispatch to be copied from.

## Header parameters

- `Content-Type` (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 Content-Type header should be set to `application/vnd.coxauto.v1+json`.

## Request body

Content types: `application/json`

## Responses

- `201` - Created. Successful request.
- `401` - Unauthorized. Authentication failed or missing.
- `403` - Forbidden. The attempted action is not permitted.
- `404` - Not Found.
- `422` - Unprocessable Entity. Errors found in the request. **Scenarios:** - Missing required parameters. - Numbers out of range. - Caller does not have access to the requested Marketplace.
- `429` - Too Many Requests. Rate limit exceeded.
- `500` - Error.
- `503` - Service Unavailable. Temporary service interruption.

## 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
paths:
  /api/fulfillments/dispatches/ref/dispatches/id/{dispatchId}:
    post:
      tags:
        - Dispatch
      summary: Create Dispatch from Canceled Dispatch
      description: >-
        
        Create a new dispatch by copying information from a canceled dispatch.


        #### 👥 Customer Type

        - Shipper


        #### 📝 Important Notes

        - All information from the canceled dispatch will be copied to the new
        dispatch.

        - A new dispatch ID will be generated automatically.

        - 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: postDispatchFromCanceled
      parameters:
        - name: dispatchId
          in: path
          description: The ID of the canceled dispatch to be copied from.
          required: true
          schema:
            type: string
            format: uuid
          example: d159acc0-e89b-12d3-a456-426614174000
        - name: Content-Type
          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 Content-Type
            header should be set to `application/vnd.coxauto.v1+json`.
          required: true
          schema:
            type: string
          example: application/vnd.coxauto.v1+json
      requestBody:
        description: "`CreateDispatchFromCanceledDispatchRequest`"
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateDispatchFromCanceledDispatchRequest"
            examples:
              ex.:
                value:
                  marketplaceId: 10000
                  externalId: RND10 CHEV
                  externalOrderId: ORD-2023-0001
                  carrierId: 0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
                  shipperRequestedPickUpDate: 2025-11-05T00:00:00.000Z
                  shipperRequestedDropOffDate: 2025-07-15T00:00:00.000Z
                  price:
                    total: 500
                    currency: USD
                    cod:
                      amount: 200
                      paymentMethod: CASH_CERTIFIED_FUNDS
                      paymentLocation: PICKUP
                    balance:
                      amount: 300
                      paymentTime: IMMEDIATELY
                      balancePaymentTermsBeginOn: PICKUP
                      balancePaymentMethod: CASH
                  additionalInformation:
                    - name: 1d1d1d1d-e89b-12d3-a456-426614174000
                      value: The number one
      responses:
        "201":
          description: Created. 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"
            Location:
              description: Contains the fully qualified URL of the newly created or updated
                resource. The final segment of the URL will equal the ID of the
                resource.
              schema:
                type: string
              example: "8675309"
        "401":
          description: Unauthorized. Authentication failed or missing.
        "403":
          description: Forbidden. The attempted action is not permitted.
        "404":
          description: Not Found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "422":
          description: |-
            Unprocessable Entity. Errors found in the request.

            **Scenarios:**

             - Missing required parameters.
             - Numbers out of range.
             - Caller does not have access to the requested Marketplace.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "429":
          description: Too Many Requests. Rate limit exceeded.
        "500":
          description: Error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorsAlt"
        "503":
          description: Service Unavailable. Temporary service interruption.
      security:
        - Bearer: []
security:
  - Bearer: []
components:
  schemas:
    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
    ErrorsAlt:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: "#/components/schemas/ErrorAlt"
          description: A collection of errors.
          nullable: true
      description: An error occurred, and the request could not be completed.
    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.
    ErrorAlt:
      type: object
      properties:
        errorID:
          type: string
          description: The ID of the error.
          nullable: true
          example: 157a16f0-503d-4256-ba60-a4876e8eb9bb
        code:
          type: string
          description: The code used for the issue.
          nullable: true
          example: resource.issue_type
        description:
          type: string
          description: A detailed message.
          nullable: true
          example: The issue happened because something is wrong.
        properties:
          type: array
          items:
            $ref: "#/components/schemas/ErrorAltProperty"
          description: Properties related to the issue.
          nullable: true
      description: Details of an error or issue.
    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
    ErrorAltProperty:
      type: object
      properties:
        property:
          type: string
          description: The name of the property.
          nullable: true
          example: person
        value:
          type: string
          description: The value of the property.
          nullable: true
          example: J0hn D03
      description: Details of an error's property.
  securitySchemes:
    Bearer:
      type: http
      scheme: Bearer
```