> ## Documentation Index
> Fetch the complete documentation index at: https://mcp.theoryofevolution.com.au/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel an Order



## OpenAPI

````yaml /openapi/agent-reseller-api.mintlify.json post /apiv1/order/{bookingReference}/cancel
openapi: 3.0.0
info:
  title: TravelDesk Agent API
  contact:
    name: API Support
    email: api@websitetravel.com
  version: '1.0'
  description: >-
    TravelDesk Agent (Reseller) API.


    ## Rate limiting


    The quota is applied **per Agent Branch key** — the per-branch client
    id/secret pair — not per account, per host, or per integration. Standard
    branches get **200 calls per minute**; upgraded branches get **900**. That
    budget is shared across everything the branch does: availability refreshes,
    background sweeps, customer-facing pricing, and quote or booking creation.


    Two consequences worth designing around:


    - A background sweep can starve customer-facing traffic for the same branch.
    Give live requests priority over refresh work, and cap the concurrency of
    any bulk job.

    - Cooldowns after a `429` must be keyed per branch. Keying them by host
    throttles every branch at once, because they all share
    `tdms.websitetravel.com`.


    Prefer endpoints that answer for a whole product in one request —
    `/apiv1/checkAvailabilityProduct` over one `/apiv1/checkavailabilityrange`
    call per fareprice — since the saving is measured against this quota.


    ## Dates


    Most endpoints take and return `DD-MON-YYYY` (`29-JUL-2026`).
    `/apiv1/checkAvailabilityProduct` returns ISO `YYYY-MM-DD` keys in `dates`.
    Parse both.


    ## Pricing


    Accommodation is dynamically priced — rates move between individual dates,
    not just between seasons — so never cache one rate per fareprice and reuse
    it across a range. Nett tracks RRP at a fixed commission ratio per
    fareprice, because changing commission requires a new
    `productPricesDetailsId`; that makes nett safe to derive from RRP rather
    than store.
servers:
  - url: https://tdms.websitetravel.com
    description: Production Server
  - url: https://tdmstest03.websitetravel.com
    description: Test Server
  - url: http://tdms.localhost
    description: Development Server
security: []
tags:
  - name: Authentication
  - name: Products
  - name: Availability and Pricing - Booking system based Live Availability
  - name: Availability and Pricing - Siteminder Live Availability
  - name: Availability and Pricing - Cached Availability and Live pricing
  - name: Availability and Pricing - Package Availability
  - name: Availability and Pricing - Check Availability via mail to supplier
  - name: Order Placement
  - name: Post Order Management
  - name: Accommodation
  - name: Reports
paths:
  /apiv1/order/{bookingReference}/cancel:
    post:
      tags:
        - Post Order Management
      summary: Cancel an Order
      operationId: step4_cancelOrder
      parameters:
        - name: bookingReference
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                totalRefundAmount:
                  description: Gross amount to be refunded to customer.
                  type: number
                  format: float
                ordersProductsRefunds:
                  type: array
                  items:
                    properties:
                      ordersProductId:
                        description: ID of OrdersProduct to refund.
                        type: integer
                      totalQty:
                        description: Quantity of OrdersProduct to refund.
                        type: integer
                      agentCancellationFee:
                        description: Amount of agent cancellation fee to apply.
                        type: number
                        format: float
                      supplierCancellationFee:
                        description: Amount of supplier cancellation fee to apply.
                        type: number
                        format: float
                      refundCategoryId:
                        description: Category of reason for refund.
                        type: integer
                      refundReason:
                        description: Description of reason for refund.
                        type: string
                      supplierContactName:
                        description: Name of supplier contact who approved the refund.
                        type: string
                      redeemers:
                        type: array
                        items:
                          properties:
                            id:
                              description: ID of redeemer to be refunded.
                              type: integer
                            qty:
                              description: >-
                                Qty of OrdersProduct to refund for this
                                redeemer.
                              type: integer
                            bookingDetails:
                              type: array
                              items:
                                description: >-
                                  IDs of BookingDetails to refund for this
                                  redeemer.
                                type: integer
                          type: object
                    type: object
                refundPayments:
                  type: array
                  items:
                    properties:
                      amount:
                        description: Amount of payment.
                        type: number
                        format: float
                      journalAccountId:
                        description: >-
                          ID of payment type. Either journalAccountId or
                          paymentMethod must be set.
                        type: integer
                      paymentMethod:
                        description: >-
                          ID of payment type. Either journalAccountId or
                          paymentMethod must be set.
                        type: string
                    type: object
              type: object
      responses:
        '204':
          description: Returned when successful.
        '400':
          description: Returned when there is an issue with the data provided.
        '403':
          description: Returned when the user is not authorized.
        '500':
          description: Returned when fatal order processing issues are encountered.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.