# [Not Implemented] Cancel order

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/orders/order-id/cancel/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/orders/order-id/cancel/llms-full.txt.

POST http://localhost:8080/api/v1/orders/{orderId}/cancel
Content-Type: application/json

> **Status: Not Implemented**

Cancel an existing order.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/orders/order-id/cancel/not-implemented-cancel-order

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/orders/{orderId}/cancel:
    post:
      operationId: not-implemented-cancel-order
      summary: '[Not Implemented] Cancel order'
      description: |
        > **Status: Not Implemented**

        Cancel an existing order.
      tags:
        - >-
          subpackage_api.subpackage_api/v1.subpackage_api/v1/orders.subpackage_api/v1/orders/orderId.subpackage_api/v1/orders/orderId/cancel
      parameters:
        - name: orderId
          in: path
          description: Order identifier
          required: true
          schema:
            type: string
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: X-Tenant-ID
          in: header
          description: Tenant identifier
          required: false
          schema:
            type: string
        - name: X-Store-ID
          in: header
          description: Store identifier
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_orders_{orderId}_cancel_[Not
                  Implemented] Cancel order_Response_200
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1OrdersOrderidCancelRequestBadRequestError
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1OrdersOrderidCancelRequestNotFoundError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                posType:
                  type: string
                reason:
                  type: string
              required:
                - posType
                - reason
servers:
  - url: http://localhost:8080
components:
  schemas:
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsUnitPrice:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsUnitPrice
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsTotalPrice:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsTotalPrice
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItemsPrice:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItemsPrice
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItemsMetadata:
      type: object
      properties:
        key_0:
          type: integer
        key_1:
          type: string
      required:
        - key_0
        - key_1
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItemsMetadata
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItems:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        price:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItemsPrice
        quantity:
          type: integer
        externalId:
          type: string
        metadata:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItemsMetadata
      required:
        - id
        - name
        - price
        - quantity
        - externalId
        - metadata
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItems
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsMetadata:
      type: object
      properties:
        key_0:
          type: integer
        key_1:
          type: string
      required:
        - key_0
        - key_1
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsMetadata
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItems:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        quantity:
          type: integer
        unitPrice:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsUnitPrice
        externalId:
          type: string
        description:
          type: string
        totalPrice:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsTotalPrice
        modifiers:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsModifiersItems
        specialInstructions:
          type: string
        metadata:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItemsMetadata
      required:
        - id
        - name
        - quantity
        - unitPrice
        - externalId
        - description
        - totalPrice
        - modifiers
        - specialInstructions
        - metadata
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItems
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTotalAmount:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTotalAmount
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderCustomerAddress:
      type: object
      properties:
        street:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
      required:
        - street
        - city
        - state
        - postalCode
        - country
        - latitude
        - longitude
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderCustomerAddress
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderCustomer:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
        address:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderCustomerAddress
      required:
        - id
        - name
        - email
        - phone
        - address
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderCustomer
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderSubtotal:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderSubtotal
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTax:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTax
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTip:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTip
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderDeliveryFee:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderDeliveryFee
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderDeliveryAddress:
      type: object
      properties:
        street:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
      required:
        - street
        - city
        - state
        - postalCode
        - country
        - latitude
        - longitude
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderDeliveryAddress
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderMetadata:
      type: object
      properties:
        key_0:
          type: number
          format: double
        key_1:
          type: integer
      required:
        - key_0
        - key_1
      title: >-
        ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderMetadata
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrder:
      type: object
      properties:
        id:
          type: string
        storeId:
          type: string
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderItemsItems
        totalAmount:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTotalAmount
        status:
          type: string
        externalId:
          type: string
        channelOrderId:
          type: string
        channelName:
          type: string
        customer:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderCustomer
        subtotal:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderSubtotal
        tax:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTax
        tip:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderTip
        deliveryFee:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderDeliveryFee
        orderType:
          type: string
        scheduledFor:
          type: string
          format: date-time
        estimatedDeliveryTime:
          type: string
          format: date-time
        pickupTime:
          type: string
          format: date-time
        deliveryAddress:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderDeliveryAddress
        notes:
          type: string
        metadata:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrderMetadata
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - storeId
        - items
        - totalAmount
        - status
        - externalId
        - channelOrderId
        - channelName
        - customer
        - subtotal
        - tax
        - tip
        - deliveryFee
        - orderType
        - scheduledFor
        - estimatedDeliveryTime
        - pickupTime
        - deliveryAddress
        - notes
        - metadata
        - createdAt
        - updatedAt
      title: ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrder
    api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_Response_200:
      type: object
      properties:
        success:
          type: boolean
        orderId:
          type: string
        externalOrderId:
          type: string
        status:
          type: string
        order:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaOrder
        message:
          type: string
      required:
        - success
        - orderId
        - externalOrderId
        - status
        - order
        - message
      title: >-
        api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel
        order_Response_200
    ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaError
    PostApiV1OrdersOrderidCancelRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1OrdersOrderidCancelRequestBadRequestError
    PostApiV1OrdersOrderidCancelRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdCancelPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1OrdersOrderidCancelRequestNotFoundError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
import requests

url = "http://localhost:8080/api/v1/orders/string/cancel"

payload = {
    "posType": "LIGHTSPEED",
    "reason": "string"
}
headers = {
    "X-Tenant-ID": "string",
    "X-Store-ID": "string",
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
const url = 'http://localhost:8080/api/v1/orders/string/cancel';
const options = {
  method: 'POST',
  headers: {
    'X-Tenant-ID': 'string',
    'X-Store-ID': 'string',
    'X-Api-Key': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"posType":"LIGHTSPEED","reason":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/orders/string/cancel"

	payload := strings.NewReader("{\n  \"posType\": \"LIGHTSPEED\",\n  \"reason\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Tenant-ID", "string")
	req.Header.Add("X-Store-ID", "string")
	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/orders/string/cancel")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Store-ID"] = 'string'
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"posType\": \"LIGHTSPEED\",\n  \"reason\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/orders/string/cancel")
  .header("X-Tenant-ID", "string")
  .header("X-Store-ID", "string")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"posType\": \"LIGHTSPEED\",\n  \"reason\": \"string\"\n}")
  .asString();
```

```php api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:8080/api/v1/orders/string/cancel', [
  'body' => '{
  "posType": "LIGHTSPEED",
  "reason": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
    'X-Store-ID' => 'string',
    'X-Tenant-ID' => 'string',
  ],
]);

echo $response->getBody();
```

```csharp api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/orders/string/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Store-ID", "string");
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"posType\": \"LIGHTSPEED\",\n  \"reason\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift api_v1_orders_{orderId}_cancel_[Not Implemented] Cancel order_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Store-ID": "string",
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "posType": "LIGHTSPEED",
  "reason": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/orders/string/cancel")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```