Post v1adminpromotions

cURL

curl --request POST \
  --url https://api.example.com/v1/admin/promotions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "value": 2,
  "perCustomerLimit": 2,
  "active": true,
  "codes": [
    "<string>"
  ],
  "currency": "<string>",
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "redemptionLimit": 2,
  "eligibility": {},
  "planIDs": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.example.com/v1/admin/promotions"

payload = {
    "code": "<string>",
    "value": 2,
    "perCustomerLimit": 2,
    "active": True,
    "codes": ["<string>"],
    "currency": "<string>",
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "redemptionLimit": 2,
    "eligibility": {},
    "planIDs": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    value: 2,
    perCustomerLimit: 2,
    active: true,
    codes: ['<string>'],
    currency: '<string>',
    startsAt: '2023-11-07T05:31:56Z',
    endsAt: '2023-11-07T05:31:56Z',
    redemptionLimit: 2,
    eligibility: {},
    planIDs: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.example.com/v1/admin/promotions', 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/v1/admin/promotions",
  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>',
    'value' => 2,
    'perCustomerLimit' => 2,
    'active' => true,
    'codes' => [
        '<string>'
    ],
    'currency' => '<string>',
    'startsAt' => '2023-11-07T05:31:56Z',
    'endsAt' => '2023-11-07T05:31:56Z',
    'redemptionLimit' => 2,
    'eligibility' => [
        
    ],
    'planIDs' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/v1/admin/promotions"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"value\": 2,\n  \"perCustomerLimit\": 2,\n  \"active\": true,\n  \"codes\": [\n    \"<string>\"\n  ],\n  \"currency\": \"<string>\",\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"redemptionLimit\": 2,\n  \"eligibility\": {},\n  \"planIDs\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

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

	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://api.example.com/v1/admin/promotions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"value\": 2,\n  \"perCustomerLimit\": 2,\n  \"active\": true,\n  \"codes\": [\n    \"<string>\"\n  ],\n  \"currency\": \"<string>\",\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"redemptionLimit\": 2,\n  \"eligibility\": {},\n  \"planIDs\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/admin/promotions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"value\": 2,\n  \"perCustomerLimit\": 2,\n  \"active\": true,\n  \"codes\": [\n    \"<string>\"\n  ],\n  \"currency\": \"<string>\",\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"redemptionLimit\": 2,\n  \"eligibility\": {},\n  \"planIDs\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "kind": "<string>",
  "active": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

POST

admin

promotions

cURL

curl --request POST \
  --url https://api.example.com/v1/admin/promotions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "value": 2,
  "perCustomerLimit": 2,
  "active": true,
  "codes": [
    "<string>"
  ],
  "currency": "<string>",
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "redemptionLimit": 2,
  "eligibility": {},
  "planIDs": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.example.com/v1/admin/promotions"

payload = {
    "code": "<string>",
    "value": 2,
    "perCustomerLimit": 2,
    "active": True,
    "codes": ["<string>"],
    "currency": "<string>",
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "redemptionLimit": 2,
    "eligibility": {},
    "planIDs": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    value: 2,
    perCustomerLimit: 2,
    active: true,
    codes: ['<string>'],
    currency: '<string>',
    startsAt: '2023-11-07T05:31:56Z',
    endsAt: '2023-11-07T05:31:56Z',
    redemptionLimit: 2,
    eligibility: {},
    planIDs: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.example.com/v1/admin/promotions', 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/v1/admin/promotions",
  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>',
    'value' => 2,
    'perCustomerLimit' => 2,
    'active' => true,
    'codes' => [
        '<string>'
    ],
    'currency' => '<string>',
    'startsAt' => '2023-11-07T05:31:56Z',
    'endsAt' => '2023-11-07T05:31:56Z',
    'redemptionLimit' => 2,
    'eligibility' => [
        
    ],
    'planIDs' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/v1/admin/promotions"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"value\": 2,\n  \"perCustomerLimit\": 2,\n  \"active\": true,\n  \"codes\": [\n    \"<string>\"\n  ],\n  \"currency\": \"<string>\",\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"redemptionLimit\": 2,\n  \"eligibility\": {},\n  \"planIDs\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

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

	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://api.example.com/v1/admin/promotions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"value\": 2,\n  \"perCustomerLimit\": 2,\n  \"active\": true,\n  \"codes\": [\n    \"<string>\"\n  ],\n  \"currency\": \"<string>\",\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"redemptionLimit\": 2,\n  \"eligibility\": {},\n  \"planIDs\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/admin/promotions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"value\": 2,\n  \"perCustomerLimit\": 2,\n  \"active\": true,\n  \"codes\": [\n    \"<string>\"\n  ],\n  \"currency\": \"<string>\",\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"redemptionLimit\": 2,\n  \"eligibility\": {},\n  \"planIDs\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "kind": "<string>",
  "active": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

code

string

required

kind

enum<string>

required

Available options:

percent,

fixed

value

integer<int64>

required

Required range: x >= 1

perCustomerLimit

integer

required

Required range: x >= 1

active

boolean

required

codes

string[]

required

currency

string

Pattern: ^[A-Z]{3}$

startsAt

string<date-time> | null

endsAt

string<date-time> | null

redemptionLimit

integer | null

Required range: x >= 1

eligibility

object

planIDs

string<uuid>[]

Response

Promotion created

string<uuid>

code

string

kind

string

active

boolean

Start

Architecture

For customers

Commerce

Integrations

API reference

Operator panel

AI and MCP

Running Omniflow

Contributing

Post v1adminpromotions

Authorizations

Body

Response