Cancel order by user

Cancel order by user

POST /api-order/orders/user/cancel

Cancel order by user

cURL

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "cancellationCode": "2001",
  "cancellationMessage": "Customer not interested"
}
'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel"

payload = {
    "cancellationCode": "2001",
    "cancellationMessage": "Customer not interested"
}
headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-site-context': '<x-site-context>',
    Authorization: '<authorization>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({cancellationCode: '2001', cancellationMessage: 'Customer not interested'})
};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellationCode' => '2001',
    'cancellationMessage' => 'Customer not interested'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json",
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel"

	payload := strings.NewReader("{\n  \"cancellationCode\": \"2001\",\n  \"cancellationMessage\": \"Customer not interested\"\n}")

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

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancellationCode\": \"2001\",\n  \"cancellationMessage\": \"Customer not interested\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel")

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

request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancellationCode\": \"2001\",\n  \"cancellationMessage\": \"Customer not interested\"\n}"

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

200

Example

{
  "orderId": "8568-9704-74294",
  "status": "Successfully cancelled order"
}

Headers

x-site-context · string · required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Authorization · string · required

Query Parameters

orderId · string · required

Required string length: 15

Example:

"2947-5955-82579"

Body

application/json

cancellationCode · string · required

Example:

"2001"

cancellationMessage · string

Example:

"Customer not interested"

Response

200

application/json

Successfully canceled order

orderId · string

Example:

"8568-9704-74294"

status · string

Example:

"Successfully cancelled order"