Skip to main content
GET
/
price-schedules
/
{scheduleId}
Price Schedule
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/price-schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

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.

Path Parameters

​
scheduleId
string
required

The unique identifier of the price schedule

Response

Price schedule details

​
id
number

Unique identifier for the price schedule

Example:

123

​
name
string

Name of the price schedule

Example:

"Holiday Sale 2023"

​
description
string

Detailed description of the price schedule

Example:

"Special pricing for holiday season"

​
status
enum<string>

Status of the price schedule

Available options:
active,
inactive
Example:

"active"

​
start_date
string<date>

When the price schedule becomes active

Example:

"2023-11-01"

​
end_date
string<date>

When the price schedule expires

Example:

"2023-12-31"

​
priority
integer

Priority of this price schedule (higher numbers take precedence)

Example:

100

​
price_levels
object[]

List of price levels this schedule applies to

​
companies
object[]

List of companies this schedule applies to (if specific to companies)

​
created_at
string<date-time>

When the price schedule was created

Example:

"2023-03-15T14:30:00Z"

​
updated_at
string<date-time>

When the price schedule was last updated

Example:

"2023-03-15T14:30:00Z"

​
counting_algorithm
string

Algorithm used for counting items for price determination

Example:

"each_item"

​
modification_type
string

Type of price modification applied

Example:

"amount_off"

​
global
boolean

Whether this price schedule applies globally

Example:

true

​
tiers
object[]

List of price schedule tiers