Skip to main content
GET
/
price-schedules
Price Schedules
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/price-schedules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "Holiday Sale 2023",
      "description": "Special pricing for holiday season",
      "status": "active",
      "start_date": "2023-11-01",
      "end_date": "2023-12-31",
      "priority": 100,
      "price_levels": [
        {
          "id": "789",
          "name": "Wholesale"
        }
      ],
      "companies": [
        {
          "id": "123456",
          "name": "Acme Corporation"
        }
      ],
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "counting_algorithm": "each_item",
      "modification_type": "amount_off",
      "global": true,
      "tiers": [
        {
          "id": 123,
          "created_at": "2023-03-15T14:30:00Z",
          "updated_at": "2023-03-15T14:30:00Z",
          "status": "active",
          "price_schedule_id": "456789",
          "quantity": 10,
          "discount_amount": 5.99
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
limit
integer
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
name
string

Filter by schedule name

​
counting_algorithm
string

Filter by counting algorithm

​
modification_type
string

Filter by modification type

Response

A list of price schedules

​
data
object[]
​
meta
object