Generate coupon codes

curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/coupon/generate-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "prefix": "SUMMER",
  "start": 1,
  "count": 3
}
'

import requests

url = "https://live.copilot.fabric.inc/api-offers/coupon/generate-codes"

payload = {
    "prefix": "SUMMER",
    "start": 1,
    "count": 3
}
headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>",
    "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: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({prefix: 'SUMMER', start: 1, count: 3})
};

fetch('https://live.copilot.fabric.inc/api-offers/coupon/generate-codes', 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://live.copilot.fabric.inc/api-offers/coupon/generate-codes",
  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([
    'prefix' => 'SUMMER',
    'start' => 1,
    'count' => 3
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://live.copilot.fabric.inc/api-offers/coupon/generate-codes"

	payload := strings.NewReader("{\n  \"prefix\": \"SUMMER\",\n  \"start\": 1,\n  \"count\": 3\n}")

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

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://live.copilot.fabric.inc/api-offers/coupon/generate-codes")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prefix\": \"SUMMER\",\n  \"start\": 1,\n  \"count\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://live.copilot.fabric.inc/api-offers/coupon/generate-codes")

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"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prefix\": \"SUMMER\",\n  \"start\": 1,\n  \"count\": 3\n}"

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

{
  "codes": [
    "SUMMER1",
    "SUMMER2",
    "SUMMER3"
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error."
}

POST

api-offers

coupon

generate-codes

Generate coupon codes

curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/coupon/generate-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "prefix": "SUMMER",
  "start": 1,
  "count": 3
}
'

import requests

url = "https://live.copilot.fabric.inc/api-offers/coupon/generate-codes"

payload = {
    "prefix": "SUMMER",
    "start": 1,
    "count": 3
}
headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>",
    "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: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({prefix: 'SUMMER', start: 1, count: 3})
};

fetch('https://live.copilot.fabric.inc/api-offers/coupon/generate-codes', 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://live.copilot.fabric.inc/api-offers/coupon/generate-codes",
  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([
    'prefix' => 'SUMMER',
    'start' => 1,
    'count' => 3
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://live.copilot.fabric.inc/api-offers/coupon/generate-codes"

	payload := strings.NewReader("{\n  \"prefix\": \"SUMMER\",\n  \"start\": 1,\n  \"count\": 3\n}")

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

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("Authorization", "Bearer <token>")
	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://live.copilot.fabric.inc/api-offers/coupon/generate-codes")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prefix\": \"SUMMER\",\n  \"start\": 1,\n  \"count\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://live.copilot.fabric.inc/api-offers/coupon/generate-codes")

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"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prefix\": \"SUMMER\",\n  \"start\": 1,\n  \"count\": 3\n}"

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

{
  "codes": [
    "SUMMER1",
    "SUMMER2",
    "SUMMER3"
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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\"}"

Body

application/json

prefix

string

required

Prefix string to generate the coupon

Required string length: 2 - 12

Example:

"SUMMER"

start

number

required

Initial number to begin generating the coupon codes

Required range: x >= 1

Example:

1

count

number

required

Number of coupon codes to be generated

Required range: x >= 1

Example:

3

Response

codes

string[]

List of generated coupon codes

Example:

["SUMMER1", "SUMMER2", "SUMMER3"]

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Generate coupon codes

Authorizations

Headers

Body

Response