All products pricing

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/products/pricing \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "name": "Basic Product",
      "sku": "BASIC-001",
      "is_active": true,
      "wholesale_price": 100,
      "retail_price": 150,
      "pricing_schedule": {
        "id": 1,
        "name": "Standard Volume Discount",
        "modification_type": "PERCENTAGE",
        "price_levels": [
          {
            "id": 1,
            "name": "Standard",
            "amount": 0,
            "tiers": [
              {
                "min_quantity": 0,
                "price": 100,
                "is_overridden": false
              }
            ]
          }
        ]
      },
      "company_pricing": [
        {
          "company": {
            "id": 1,
            "name": "Test Business 1"
          },
          "price": 140
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

Products

All products pricing

Retrieve comprehensive pricing information for products, including base prices, pricing tiers, price levels, and any company-specific pricing overrides.

This endpoint returns detailed pricing information that shows volume-based pricing tiers across different price levels as configured in each product’s pricing schedule.

This endpoint supports filtering with the same parameters as the products endpoint, allowing you to retrieve pricing data for specific sets of products.

For detailed information about the filtering system and available operators, refer to the Filter System Documentation.

Available Filters

String Filters

name: Product name
description: Product description
sku: Product SKU (searches both internal SKU and alternate SKUs)
upc: Product UPC/Barcode
tag: Product tags
q: General search matches name OR upc OR sku
category.name: Filter by category name
sub_category.name: Filter by sub-category name
supplier.name: Filter by supplier name

Integer Filters

category.id: Filter by category ID
sub_category.id: Filter by sub-category ID
supplier.id: Filter by supplier ID

Float Filters

retail_price: Product retail price
wholesale_price: Product wholesale price

Boolean Filters

sellable: If the product is sellable or not
discontinued: If the product is discontinued

DateTime Filters

created_at: When the product was created
updated_at: When the product was last updated

Examples

# Find products by SKU with pricing details
?sku[eq]=SKU-001

# Find products with specific price range
?retail_price[gte]=50.00&retail_price[lte]=100.00

# Find products by category and sub-category with pricing details
?category.name[eq]=Electronics&sub_category.name[eq]=Smartphones

GET

products

pricing

All products pricing

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/products/pricing \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "name": "Basic Product",
      "sku": "BASIC-001",
      "is_active": true,
      "wholesale_price": 100,
      "retail_price": 150,
      "pricing_schedule": {
        "id": 1,
        "name": "Standard Volume Discount",
        "modification_type": "PERCENTAGE",
        "price_levels": [
          {
            "id": 1,
            "name": "Standard",
            "amount": 0,
            "tiers": [
              {
                "min_quantity": 0,
                "price": 100,
                "is_overridden": false
              }
            ]
          }
        ]
      },
      "company_pricing": [
        {
          "company": {
            "id": 1,
            "name": "Test Business 1"
          },
          "price": 140
        }
      ]
    }
  ],
  "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

per_page

integer

default:10

Number of items per page (max 100)

Required range: x <= 100

string

Filter by name OR upc OR sku

name

string

Filter by product name

description

string

Filter by product description

sku

string

Filter by SKU (searches both internal and alternate SKUs)

upc

string

Filter by UPC/Barcode

sellable

boolean

Filter by sellable status

discontinued

boolean

Filter by whether the product is discontinued

retail_price

number<float>

Filter by retail price

wholesale_price

number<float>

Filter by wholesale price

created_at

string<date-time>

Filter by creation date

updated_at

string<date-time>

Filter by last update date

tag

string

Filter by product tags

category.id

integer

Filter by category ID

category.name

string

Filter by category name

sub_category.id

integer

Filter by sub-category ID

sub_category.name

string

Filter by sub-category name

supplier.id

integer

Filter by supplier ID

supplier.name

string

Filter by supplier name

Response

List of products with pricing information

data

object[]

Show child attributes

Products

Purchase Orders

Inventory

Transfer Orders

Receiving Reports

Sales Orders

Invoices

Tags

Custom Fields

Locations

Companies

Contacts

Pricing

BOMs

All products pricing

Available Filters

String Filters

Integer Filters

Float Filters

Boolean Filters

DateTime Filters

Examples

Authorizations

Query Parameters

Response