POST
/
catalog
/
promotion
Create promotion
curl --request POST \
  --url https://api.example.com/catalog/promotion \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "date_started": "<string>",
  "group": "<string>",
  "title": "<string>",
  "auto_apply": true,
  "data": {},
  "date_ended": "<string>",
  "description": "<string>",
  "is_enabled": true,
  "priority": 123,
  "refs": [
    {
      "ref_id": "<string>"
    }
  ]
}
'
import requests

url = "https://api.example.com/catalog/promotion"

payload = {
"code": "<string>",
"date_started": "<string>",
"group": "<string>",
"title": "<string>",
"auto_apply": True,
"data": {},
"date_ended": "<string>",
"description": "<string>",
"is_enabled": True,
"priority": 123,
"refs": [{ "ref_id": "<string>" }]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: '<string>',
date_started: '<string>',
group: '<string>',
title: '<string>',
auto_apply: true,
data: {},
date_ended: '<string>',
description: '<string>',
is_enabled: true,
priority: 123,
refs: [{ref_id: '<string>'}]
})
};

fetch('https://api.example.com/catalog/promotion', 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://api.example.com/catalog/promotion",
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([
'code' => '<string>',
'date_started' => '<string>',
'group' => '<string>',
'title' => '<string>',
'auto_apply' => true,
'data' => [

],
'date_ended' => '<string>',
'description' => '<string>',
'is_enabled' => true,
'priority' => 123,
'refs' => [
[
'ref_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$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://api.example.com/catalog/promotion"

payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"date_started\": \"<string>\",\n \"group\": \"<string>\",\n \"title\": \"<string>\",\n \"auto_apply\": true,\n \"data\": {},\n \"date_ended\": \"<string>\",\n \"description\": \"<string>\",\n \"is_enabled\": true,\n \"priority\": 123,\n \"refs\": [\n {\n \"ref_id\": \"<string>\"\n }\n ]\n}")

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

req.Header.Add("Authorization", "<api-key>")
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://api.example.com/catalog/promotion")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"date_started\": \"<string>\",\n \"group\": \"<string>\",\n \"title\": \"<string>\",\n \"auto_apply\": true,\n \"data\": {},\n \"date_ended\": \"<string>\",\n \"description\": \"<string>\",\n \"is_enabled\": true,\n \"priority\": 123,\n \"refs\": [\n {\n \"ref_id\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/catalog/promotion")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"date_started\": \"<string>\",\n \"group\": \"<string>\",\n \"title\": \"<string>\",\n \"auto_apply\": true,\n \"data\": {},\n \"date_ended\": \"<string>\",\n \"description\": \"<string>\",\n \"is_enabled\": true,\n \"priority\": 123,\n \"refs\": [\n {\n \"ref_id\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "auto_apply": true,
    "code": "<string>",
    "data": {},
    "date_created": "<string>",
    "date_ended": "<string>",
    "date_started": "<string>",
    "date_updated": "<string>",
    "description": "<string>",
    "group": "<string>",
    "id": "<string>",
    "is_enabled": true,
    "owner_id": "<string>",
    "priority": 123,
    "refs": [
      {
        "ref_id": "<string>"
      }
    ],
    "title": "<string>"
  },
  "error": {
    "code": "<string>",
    "http_status": 123,
    "message": "<string>"
  }
}
{
"data": "<unknown>",
"error": {
"code": "<string>",
"http_status": 123,
"message": "<string>"
}
}
{
"data": "<unknown>",
"error": {
"code": "<string>",
"http_status": 123,
"message": "<string>"
}
}

Authorizations

Authorization
string
header
required

JWT access token. Format: "Bearer <token>".

Body

application/json

Promotion payload

code
string
required
date_started
string
required
group
string
required
title
string
required
type
enum<string>
required
Available options:
Discount,
ShipDiscount,
Bundle,
BuyXGetY,
Cashback
auto_apply
boolean
data
object
date_ended
string
description
string
is_enabled
boolean
priority
integer
refs
object[]

Response

OK

data
object
error
object