GET
/
v0
/
discounts
/
list
curl --request GET \
  --url https://api.fungies.io/v0/discounts/list \
  --header 'x-fngs-public-key: <api-key>'
{
  "status": "<string>",
  "data": {
    "discounts": [
      {
        "object": "discount",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "code",
        "name": null,
        "amount": "<string>",
        "amountType": "fixed",
        "discountCode": null,
        "validFrom": null,
        "validUntil": null,
        "purchaseLimit": null,
        "timesUsed": 0,
        "status": "active",
        "includesAllOffers": false,
        "currency": "AFN"
      }
    ],
    "count": 0
  }
}

Authorizations

x-fngs-public-key
string
header
required

Query Parameters

ids
string[]

GET /v0/discounts/list Parameter

termOrId
string

GET /v0/discounts/list Parameter

status
enum<string>

GET /v0/discounts/list Parameter

Available options:
active,
inactive
type
enum<string>

GET /v0/discounts/list Parameter

Available options:
code,
sale
currency
enum<string>

GET /v0/discounts/list Parameter

Available options:
AFN,
ALL,
DZD,
AOA,
ARS,
AMD,
AWG,
AUD,
AZN,
BSD,
BDT,
BBD,
BZD,
BMD,
BOB,
BAM,
BWP,
BRL,
BHD,
GBP,
BND,
BGN,
BIF,
BYN,
KHR,
CAD,
CVE,
KYD,
KWD,
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,
JOD,
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,
OMR,
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,
TND,
TOP,
TTD,
TRY,
UGX,
UAH,
AED,
UYU,
USD,
UZS,
VUV,
VEF,
VND,
XOF,
YER,
ZMW,
SLE
validFrom
integer | null

GET /v0/discounts/list Parameter

Required range: 0 <= x <= 9007199254740991
validUntil
integer | null

GET /v0/discounts/list Parameter

Required range: 0 <= x <= 9007199254740991
orderBy
enum<string>

GET /v0/discounts/list Parameter

Available options:
createdAt,
name,
amount
orderDirection
enum<string>

GET /v0/discounts/list Parameter

Available options:
ASC,
DESC
skip
number

GET /v0/discounts/list Parameter

Required range: 0 <= x <= 1.7976931348623157e+308
take
number

GET /v0/discounts/list Parameter

Required range: 0 <= x <= 1.7976931348623157e+308
archived

GET /v0/discounts/list Parameter

expired

GET /v0/discounts/list Parameter

withArchived

GET /v0/discounts/list Parameter

returnCount

GET /v0/discounts/list Parameter

Response

200
application/json
GET /v0/discounts/list Positive response
status
string
required
Allowed value: "success"
data
object
required