Delete redemption by ID - Fabric

Delete redemption by ID

cURL

curl --request DELETE \
  --url https://api.fabric.inc/v3/redemptions/{redemptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'

Python

import requests

url = "https://api.fabric.inc/v3/redemptions/{redemptionId}"

headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.delete(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'DELETE',
  headers: {'x-fabric-tenant-id': '<x-fabric-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.fabric.inc/v3/redemptions/{redemptionId}', 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://api.fabric.inc/v3/redemptions/{redemptionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

$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"
    "net/http"
    "io"
)

func main() {

url := "https://api.fabric.inc/v3/redemptions/{redemptionId}"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
    req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))
}

Java (Unirest)

HttpResponse<String> response = Unirest.delete("https://api.fabric.inc/v3/redemptions/{redemptionId}")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/redemptions/{redemptionId}")

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

request = Net::HTTP::Delete.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["Authorization"] = 'Bearer <token>'

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

Responses

• 200
  • Response example:

    {
      "id": "614b58924e92f6861ac9d43b",
      "isDeleted": true
    }
    

• 400
  • Response example:

    {
      "type": "REDEMPTION_ID_NOT_VALID",
      "message": "Redemption ID isn't valid, it needs must be a valid Object ID"
    }
    

• 401
  • Response example:

    {
      "type": "UNAUTHORIZED",
      "message": "Invalid credentials"
    }
    

• 404
  • Response example:

    {
      "type": "REDEMPTION_NOT_FOUND",
      "message": "The redemption record doesn't exist."
    }
    

• 500
  • Response example:

    {
      "type": "INTERNAL_SERVER_ERROR",
      "message": "Internal server error"
    }
    

Authorizations

Authorization

• Type: string
• Location: header
• Required: Yes
• Description: Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

• x-fabric-tenant-id: Required for identifying the tenant.
• x-fabric-channel-id: Required for sales channel identification.
• x-client-id: Unique identifier for the System app.
• x-fabric-request-id: Unique request ID.

Path Parameters

• redemptionId: Required ID for the redemption created to delete it.