---
title: "Retrieves a product cancellation policy or cancels a product in an order"
method: POST
path: "/cancel/{orderId}/{orderKey}/{productId}"
tags: ["BookingFlow"]
---

# Retrieves a product cancellation policy or cancels a product in an order

`POST /cancel/{orderId}/{orderKey}/{productId}`

## Request

- Base URL: `https://api.travelify.io`
- URL: `https://api.travelify.io/cancel/{orderId}/{orderKey}/{productId}`
- Auth: none declared

## Path parameters

- `orderId` integer, required
- `orderKey` string, required
- `productId` integer, required

## Request body

- CancelCriteria: Cancellation criteria
  - `confirm` boolean: Confirm cancellation
  - `cancellationReason` string, nullable: Cancellation reason
  - `isAdminSystem` boolean: Flag to define if admin system
  - `userRef` string, nullable: Optional user reference calling the cancellation

## Response `200`

Success - Returns the status of the cancellation request.

- APIResponseData: Model defining the data API response.
  - `success` boolean: Indicator as to whether API request was successful.
  - `error` string, nullable: Returns an error if success is returned as false.
  - `data` unknown
  - `deposit` OrderDepositOptionDBO: Model for defining deposit option
    - `id` integer: Deposit identifier
    - `optionId` integer: Deposit option identifier
    - `initialAmount` number, double: Initial payment amount
    - `currency` string, nullable: Currency code
    - `breakdown` DepositBreakdown[], nullable: Breakdown
      - `num` integer: Installment number
      - `amount` number, double: Installment amount
      - `dueDate` string, date-time: Installment due date
      - `supplierDueDate` string, date-time, nullable: Optional supplier balance due date

## Other responses

- `400`: Bad request - check the response message for what information is missing or incorrect.
- `401`: Authentication error - check your authentication headers.
- `417`: Error response - check the response errors for more information.
- `500`: Error response - internal unrecoverable system error.

---

[API](https://skmtc.dev/travelify/apis/travelify-io-api.md) - [All operations](https://skmtc.dev/travelify/apis/travelify-io-api/llms.txt) - [OpenAPI document](https://skmtc.dev/travelify/apis/travelify-io-api/revisions/70f1c708e1af?raw)