Skip to main content
GET
/
price-levels
Price Levels
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/price-levels \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "created_at": "2023-03-15T14:30:00Z",
      "updated_at": "2023-03-15T14:30:00Z",
      "status": "active",
      "name": "Wholesale",
      "type": "percentage",
      "percent_increase": 15.5
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To obtain a token, contact [email protected]

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
​
sort
string
default:id:desc

Sort results by field and direction. Format: field:direction

Examples:

  • name:asc - Sort by name in ascending order
  • created_at:desc - Sort by creation date in descending order
  • id:asc - Sort by ID in ascending order

Default is id:desc

​
name
string

Filter by level name

​
type
string

Filter by level type

​
percent_increase
number<float>

Filter by percentage increase

Response

A list of price levels

​
data
object[]
​
meta
object