Cancel order - Fabric

Cancel order

cURL

curl --request PATCH \
  --url https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "cancellationCode": "2001",
  "orderId": "2947-5955-82579",
  "cancellationMessage": "Customer not interested"
}
'

Python

import requests

url = "https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/cancel"

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

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

print(response.text)

JavaScript (Fetch)

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

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

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellationCode' => '2001',
    'orderId' => '2947-5955-82579',
    'cancellationMessage' => 'Customer not interested'
  ]),
  CURLOPT_HTTPHEADER => [
    "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;
}
?>

Go

package main

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

func main() {

url := "https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/cancel"

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

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

req.Header.Add("x-site-context", "<x-site-context>")
    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))
}

Unirest

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

Ruby

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.yourcompany.fabric.zone/api-order/orders/cancel")

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

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

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

Example Response

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

Headers

x-api-key
string
Example:
"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

x-site-context
string, required
Example:
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

cancellationCode
string, required
Example:
"2001"

orderId
string, required
Example:
"2947-5955-82579"

cancellationMessage
string
Example:
"Customer not interested"

Response

Success response:

200
application/json
Example:
{"orderId": "8568-9704-74294", "status": "Successfully cancelled order"}