OrderCancel

POST

https://polarhub-tsdv001.sandbox.halo-platform.net/hub/polarpie/v2/orderCancel

PolarHub API

Last modified:2026-04-02 06:52:27

Overview

This part of the guide details the use of the OrderCancel API to void or cancel a previously created order. It provides instructions on how to properly terminate a booking and process any related actions.

Usage Guidelines

Cancel

Cancels a held (un-ticketed) reservation.

VOID

Cancels the reservation and VOIDs the ticket(s).

Refund

Cancels the reservation and Refunds the ticket(s).

Request

Header Params

Body Params application/json

Example

{
    "Sender": {
        "TravelAgency": {
            "AgencyID": "TSDV001",
            "SiteCode": "01",
            "ContactInfoRefID": []
        }
    },
    "PointOfSale": "KR",
    "TransactionID": "8d6ec82e0d3546eaacc49be57b71cef5",
    "Query": {
        "OrderID": "TSDEV-20240315-6f464b4b8d80f67f"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://polarhub-tsdv001.sandbox.halo-platform.net/hub/polarpie/v2/orderCancel' \
--header 'x-date: {{Header Construction - Step 1: Date Header}}' \
--header 'Digest: SHA-512={{Header Construction - Step 2: Digest Header}}' \
--header 'Authorization: hmac username={{TenantID}}, algorithm="hmac-sha512", headers="x-date digest", signature={{Header Construction - Step 3: Authorization Header}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Sender": {
        "TravelAgency": {
            "AgencyID": "TSDV001",
            "SiteCode": "01",
            "ContactInfoRefID": []
        }
    },
    "PointOfSale": "KR",
    "TransactionID": "8d6ec82e0d3546eaacc49be57b71cef5",
    "Query": {
        "OrderID": "TSDEV-20240315-6f464b4b8d80f67f"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "ResultMessage": {
        "Code": "string",
        "Message": "string",
        "MessageDetail": {
            "Errors": [
                {
                    "Owner": "string",
                    "Message": "string",
                    "Code": "string",
                    "Status": "string",
                    "ShortText": "string",
                    "Type": "string"
                }
            ],
            "Warnings": [
                {
                    "Owner": "string",
                    "Message": "string",
                    "Code": "string",
                    "Status": "string",
                    "ShortText": "string",
                    "Type": "string"
                }
            ]
        }
    },
    "Recipient": {
        "TravelAgency": {
            "AgencyID": "string",
            "SiteCode": "string",
            "AgencyName": "string",
            "ContactInfoRefID": [
                "string"
            ]
        }
    },
    "PointOfSale": "string",
    "TransactionID": "string",
    "AugmentationPoint": {
        "Any": [
            {}
        ]
    }
}

Modified at 2026-04-02 06:52:27

OrderQuote

OrderChangeNotif

OrderCancel

Overview#

Usage Guidelines#

Cancel#

VOID#

Refund#