Search discounts

GET

discounts

list

Authorizations

Public-Key

string

headerrequired

Query Parameters

ids

string[]

GET /v1/discounts/list Parameter

termOrId

string

GET /v1/discounts/list Parameter

status

enum<string>

GET /v1/discounts/list Parameter

Available options:

active,

inactive

type

enum<string>

GET /v1/discounts/list Parameter

Available options:

code,

sale

currency

enum<string>

GET /v1/discounts/list Parameter

Available options:

AFN,

ALL,

DZD,

AOA,

ARS,

AMD,

AWG,

AUD,

AZN,

BSD,

BDT,

BBD,

BZD,

BMD,

BOB,

BAM,

BWP,

BRL,

GBP,

BND,

BGN,

BIF,

BYN,

KHR,

CAD,

CVE,

KYD,

XAF,

XPF,

CLP,

CNY,

COP,

KMF,

CDF,

CRC,

HRK,

CZK,

DKK,

DJF,

DOP,

XCD,

EGP,

ETB,

EUR,

FKP,

FJD,

GMD,

GEL,

GIP,

GTQ,

GNF,

GYD,

HTG,

HNL,

HKD,

HUF,

ISK,

INR,

IDR,

ILS,

JMD,

JPY,

KZT,

KES,

KGS,

LAK,

LBP,

LSL,

LRD,

MOP,

MKD,

MGA,

MWK,

MYR,

MVR,

MRO,

MUR,

MXN,

MDL,

MNT,

MAD,

MZN,

MMK,

NAD,

NPR,

ANG,

TWD,

NZD,

NIO,

NGN,

NOK,

PKR,

PAB,

PGK,

PYG,

PEN,

PHP,

PLN,

QAR,

RON,

RUB,

RWF,

SHP,

SVC,

WST,

STD,

SAR,

RSD,

SCR,

SLL,

SGD,

SBD,

SOS,

ZAR,

KRW,

LKR,

SRD,

SZL,

SEK,

CHF,

TJS,

TZS,

THB,

TOP,

TTD,

TRY,

UGX,

UAH,

AED,

UYU,

USD,

UZS,

VUV,

VEF,

VND,

XOF,

YER,

ZMW,

SLE

validFrom

integer

GET /v1/discounts/list Parameter

Required range: 0 < x < 9007199254740991

validUntil

integer

GET /v1/discounts/list Parameter

Required range: 0 < x < 9007199254740991

orderBy

enum<string>

GET /v1/discounts/list Parameter

Available options:

createdAt,

name,

amount

orderDirection

enum<string>

GET /v1/discounts/list Parameter

Available options:

ASC,

DESC

skip

number

GET /v1/discounts/list Parameter

Required range: 0 < x < 1.7976931348623157e+308

take

number

GET /v1/discounts/list Parameter

Required range: 0 < x < 1.7976931348623157e+308

archived

boolean | null

default: false

GET /v1/discounts/list Parameter

withArchived

boolean | null

default: false

GET /v1/discounts/list Parameter

returnCount

boolean | null

default: false

GET /v1/discounts/list Parameter

Response

200 - application/json

status

string

required

Allowed value: "success"

data

object

required

data.discounts

object[]

required

data.discounts.id

string

required

data.discounts.name

string | null

required

data.discounts.discountCode

string

data.discounts.type

string

required

data.discounts.amount

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.amountType

string

required

data.discounts.validFrom

integer

required

Required range: 0 < x < 9007199254740991

data.discounts.validUntil

integer

Required range: 0 < x < 9007199254740991

data.discounts.purchaseLimit

number

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.timesUsed

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.status

enum<string>

required

Available options:

active,

inactive

data.discounts.offers

object[]

required

data.discounts.offers.name

string

data.discounts.offers.description

string

data.discounts.offers.media

object

data.discounts.offers.id

string

required

data.discounts.offers.price

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.offers.originalPrice

number

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.offers.currency

string

required

data.discounts.offers.formatted

object

required

data.discounts.offers.limit

number | null

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.offers.recurringInterval

enum<string> | null

Available options:

day,

month,

week,

year

data.discounts.offers.soldItems

number

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.offers.availableItems

number | null

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

data.discounts.offers.sellable

boolean

required

data.discounts.offers.status

enum<string>

Available options:

DRAFT,

OPEN,

CLOSED,

SOLD

data.discounts.offers.tags

object[]

data.discounts.offers.gtin

string

data.discounts.offers.platform

string

data.discounts.offers.region

enum<string>

Available options:

Global,

Europe,

Argentina,

United States,

Turkey,

United Kingdom,

Latin America,

Brazil,

Canada,

Mexico,

Germany,

Colombia,

France,

Saudi Arabia,

Australia,

Spain,

India,

Italy,

Netherlands,

United Arab Emirates,

North America,

Poland,

Belgium,

Asia,

Egypt,

Austria,

Singapore,

EMEA,

Ireland,

RU/CIS,

Sweden,

Portugal,

Switzerland,

New Zealand,

Malaysia,

Finland,

Greece,

Norway,

Denmark,

Japan,

Hong Kong,

Philippines,

Middle East,

Indonesia,

Czech Republic,

South Africa,

South Korea,

Luxembourg,

Slovakia,

Romania,

Slovenia,

Hungary,

Chile,

Nigeria,

Thailand,

Kuwait,

Vietnam,

Rest of the World,

Bahrain,

Qatar

data.discounts.offers.variant

object

data.discounts.offers.warningMessage

string

data.discounts.offers.createdAt

integer

Required range: 0 < x < 9007199254740991

data.discounts.offers.deletedAt

integer | null

Required range: 0 < x < 9007199254740991

data.discounts.currency

enum<string>

required

Available options:

AFN,

ALL,

DZD,

AOA,

ARS,

AMD,

AWG,

AUD,

AZN,

BSD,

BDT,

BBD,

BZD,

BMD,

BOB,

BAM,

BWP,

BRL,

GBP,

BND,

BGN,

BIF,

BYN,

KHR,

CAD,

CVE,

KYD,

XAF,

XPF,

CLP,

CNY,

COP,

KMF,

CDF,

CRC,

HRK,

CZK,

DKK,

DJF,

DOP,

XCD,

EGP,

ETB,

EUR,

FKP,

FJD,

GMD,

GEL,

GIP,

GTQ,

GNF,

GYD,

HTG,

HNL,

HKD,

HUF,

ISK,

INR,

IDR,

ILS,

JMD,

JPY,

KZT,

KES,

KGS,

LAK,

LBP,

LSL,

LRD,

MOP,

MKD,

MGA,

MWK,

MYR,

MVR,

MRO,

MUR,

MXN,

MDL,

MNT,

MAD,

MZN,

MMK,

NAD,

NPR,

ANG,

TWD,

NZD,

NIO,

NGN,

NOK,

PKR,

PAB,

PGK,

PYG,

PEN,

PHP,

PLN,

QAR,

RON,

RUB,

RWF,

SHP,

SVC,

WST,

STD,

SAR,

RSD,

SCR,

SLL,

SGD,

SBD,

SOS,

ZAR,

KRW,

LKR,

SRD,

SZL,

SEK,

CHF,

TJS,

TZS,

THB,

TOP,

TTD,

TRY,

UGX,

UAH,

AED,

UYU,

USD,

UZS,

VUV,

VEF,

VND,

XOF,

YER,

ZMW,

SLE

data.count

number | null

required

Required range: -1.7976931348623157e+308 < x < 1.7976931348623157e+308

Introduction Create a new discount

API Documentation

DISCOUNTS

OFFERS

ORDERS

PRODUCTS

SUBSCRIPTIONS

USERS

Search discounts

Authorizations

Query Parameters

Response