FaxStore

Our Discord

Weblutions Documentation / FaxStore / Sales API

Sales API

The FaxStore Sales API allows sales and promotional discounts to be created, retrieved, and removed through the API. Sales can be applied to all items, a specific store category, or an individual item, with a defined discount percentage and expiry time. The available endpoints allow you to retrieve all active sales, retrieve a specific sale by ID, create a new sale, or delete an existing sale.

Table of Contents

Get All Sales

GET/api/sales

Returns an array of all sales running on the store.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "id": 10,
    "name": "Test Sale",
    "items": "9",
    "saleamount": "10",
    "expiry": "",
    "createdAt": "1734312724298"
  }
]

401Unauthorizedplaintext

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

response = requests.get('https://api.example.com/api/sales', 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/sales', false, $context);
$data = json_decode($response, true);

Get Sale

GET/api/sales/:id

Returns the requested sales in an object.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The internal database ID of the sale.

Responses

200OKjson

View response body

{
  "id": 10,
  "name": "test",
  "items": "9",
  "saleamount": "10",
  "expiry": "",
  "createdAt": "1734312724298"
}

401Unauthorizedplaintext

View response body

You are not authorized to access this resource.

404Not Foundplaintext

View response body

Sale not found.

Examples

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

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

import requests

response = requests.get('https://api.example.com/api/sales/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/sales/123', false, $context);
$data = json_decode($response, true);

Create Sale

POST/api/sales

Create a sale with the provided details to run on the store.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
name	String	required	The name or description of the sale (displayed internally)
items	String	required	A product ID, category, or astricks for everything. See ntoe.
expiry	Integer	required	MS timestamp specifying when the sale will end.
saleamount	Integer	required	Integer representing the percentage discount to apply.

Responses

200OKjson

View response body

{
  "id": 10,
  "name": "Test Sale",
  "items": "9",
  "saleamount": "10",
  "expiry": "",
  "createdAt": "1734312724298"
}

400Bad Bodyplaintext

View response body

Invalid store cateogry ID provided.
Missing required body item - items are required
Invalid store item ID provided.

401Unauthorizedplaintext

View response body

You are not authorized to access this resource.

Examples

curl -X POST 'https://api.example.com/api/sales' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "example_name",
  "items": "example_items",
  "expiry": 123,
  "saleamount": 123
}'

const response = await fetch('https://api.example.com/api/sales', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "name": "example_name",
  "items": "example_items",
  "expiry": 123,
  "saleamount": 123
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/sales', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "name": "example_name",
    "items": "example_items",
    "expiry": 123,
    "saleamount": 123
})
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([
        "name" => "example_name",
        "items" => "example_items",
        "expiry" => 123,
        "saleamount" => 123
    ])
  ]
]);

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

Notes:

For the items body field:
- Use * for all items, sc-XX for a store category, or XX for a specific item ID.
- XX in the above represent a product or category ID.
Expiries must be in the future or the sale will not begin and will delete within 24 hours.

Delete Sale

DELETE/api/sales/:id

Deletes a sale from the database and ends its active state.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The database ID of the sale to delete.

Responses

201OKplaintext

View response body

(no content)

404Not Foundplaintext

View response body

Sale ID not found.

401Unauthorizedjson

View response body

You are not authorized to access this resource.

Examples

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

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

import requests

response = requests.delete('https://api.example.com/api/sales/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/sales/123', false, $context);
$data = json_decode($response, true);