FaxStore

Our Discord

Weblutions Documentation / FaxStore / Discounts API

Discounts API

The Discounts API for FaxStore enables seamless management of promotional offers by supporting the creation, deletion, modification, and retrieval of discount codes. This streamlined interface helps maintain and update discount information effortlessly across your e-commerce platform.

Table of Contents

Get All Discounts

GET/api/discounts

Returns all promotional codes on the store.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "id": 1,
    "code": "flash",
    "discount": "50",
    "createdAt": "1652928195141",
    "uses": 0,
    "maxlimit": "-1",
    "reqRoles": "",
    "expire": "1652928315141",
    "whitelist": null,
    "paused": null
  },
  ...
]

404Not Foundplaintext

View response body

Discounts not found.

Examples

curl -X GET 'https://api.example.com/api/discounts' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/discounts', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/discounts', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/discounts', false, $context);
$data = json_decode($response, true);

Get Single Discount

GET/api/discount/:id

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The ID of the discount code

Responses

200OKjson

View response body

{
  "id": 1,
  "code": "flash",
  "discount": "50",
  "createdAt": "1652928195141",
  "uses": 0,
  "maxlimit": "-1",
  "reqRoles": "",
  "expire": "1652928315141",
  "whitelist": null,
  "paused": null
}

404Not Foundplaintext

View response body

Discount not found.

Examples

curl -X GET 'https://api.example.com/api/discount/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/discount/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/discount/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/discount/123', false, $context);
$data = json_decode($response, true);

Create Discount

POST/api/discount

Creates a promotional code / discount code on the store.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
code	String	required	The discount code used at checkout.
discount	Mixed	required	The discount amount. A plain number is used as a percentage while a number prefixed with a minus symbol indicates a fixed amount.
limit	Integer	optional	The max amount of uses for the code. Defaults to unlimited (0).
roles	String	optional	Discord server roles required to use the discount code. Multiple roles can be specified by a comma seperated list.
expire	Timestamp	optional	A timestamp in MS of when the discount code will expire.
paused	Boolean	optional	Pauses the discount code from use. Defaults to false.

Responses

200OKjson

View response body

{
  "id": 11,
  "code": "testcodelol",
  "discount": "50",
  "createdAt": "1723779824782",
  "uses": 0,
  "maxlimit": "0",
  "reqRoles": "",
  "expire": "",
  "whitelist": null,
  "paused": 0
}

400Invalid Requestplaintext

View response body

Missing required body items - code and discount are required.

404Not Foundplaintext

View response body

Discount ID not found after creation.

Examples

curl -X POST 'https://api.example.com/api/discount' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "example_code",
  "discount": "example_discount",
  "limit": 123,
  "roles": "example_roles",
  "expire": "example_expire",
  "paused": true
}'

const response = await fetch('https://api.example.com/api/discount', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "code": "example_code",
  "discount": "example_discount",
  "limit": 123,
  "roles": "example_roles",
  "expire": "example_expire",
  "paused": true
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/discount', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "code": "example_code",
    "discount": "example_discount",
    "limit": 123,
    "roles": "example_roles",
    "expire": "example_expire",
    "paused": True
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "code" => "example_code",
        "discount" => "example_discount",
        "limit" => 123,
        "roles" => "example_roles",
        "expire" => "example_expire",
        "paused" => true
    ])
  ]
]);

$response = file_get_contents('https://api.example.com/api/discount', false, $context);
$data = json_decode($response, true);

Delete Discount

DELETE/api/discount/:id

Deletes the provided discount.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The database ID of the discount

Responses

201OKjson

View response body

(no content)

404Not Foundplaintext

View response body

Discount not found.

Examples

curl -X DELETE 'https://api.example.com/api/discount/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/discount/123', {
  "method": "DELETE",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.delete('https://api.example.com/api/discount/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'DELETE',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/discount/123', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...