Company Products

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

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "retail_price": 123,
      "wholesale_price": 123,
      "unit_cost": 123,
      "landed_cost": 123,
      "manufacturing_fee": 123,
      "company_prices": [
        {
          "company_id": 1,
          "company_name": "Electronics Retailer Pro",
          "price": 91.99
        }
      ],
      "product_weight": 123,
      "product_length": 123,
      "product_width": 123,
      "product_height": 123,
      "qty_low_alert": 123,
      "qty_reorder_threshold": 123,
      "qty_minimum": 123,
      "sellable": true,
      "discontinued": true,
      "image_url": "<string>",
      "category": {
        "id": 123,
        "name": "<string>"
      },
      "subcategory": {
        "id": 123,
        "name": "<string>"
      },
      "custom_fields": {},
      "attachments": [
        {
          "id": 123,
          "name": "<string>",
          "type": "<string>",
          "size": 123,
          "full_url": "<string>",
          "thumb_url": "<string>"
        }
      ],
      "variants": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "attachments": [
            {
              "id": 123,
              "name": "<string>",
              "type": "<string>",
              "size": 123,
              "full_url": "<string>",
              "thumb_url": "<string>"
            }
          ],
          "retail_price": 123,
          "wholesale_price": 123,
          "company_prices": [
            {
              "company_id": 1,
              "company_name": "Electronics Retailer Pro",
              "price": 91.99
            }
          ],
          "custom_fields": [
            {}
          ],
          "variant_attributes": {},
          "sku": "<string>",
          "upc": "<string>",
          "sellable": true,
          "discontinued": true,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "variant_attributes": {},
      "sku": "<string>",
      "alternate_skus": [
        {
          "id": 123,
          "sku": "<string>"
        }
      ],
      "upc": "<string>",
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ],
      "substitutions": [
        {
          "id": 123,
          "priority": 123,
          "product": {
            "id": 123,
            "name": "<string>",
            "description": "<string>",
            "retail_price": 123,
            "wholesale_price": 123,
            "unit_cost": 123,
            "product_weight": 123,
            "product_length": 123,
            "product_width": 123,
            "product_height": 123,
            "sellable": true,
            "discontinued": true,
            "image_url": "<string>",
            "sku": "<string>",
            "upc": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "supplier": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

{
  "message": "<string>"
}

Companies

Company Products

Get a paginated list of products associated with a specific company.

Each product includes a calculated price field that reflects the company-specific pricing based on their assigned price levels, price groups, and any applicable discounts or markups for the product’s category.

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 (includes alternate SKUs)
?sku[eq]=SKU-001

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

# Find recently updated products
?updated_at[gte]=2024-01-01 00:00:00

# Search products by name
?name[contains]=Test Product

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

# Find products by supplier
?supplier.name[contains]=Acme

GET

companies

{companyId}

products

Company Products

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

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/companies/{companyId}/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "retail_price": 123,
      "wholesale_price": 123,
      "unit_cost": 123,
      "landed_cost": 123,
      "manufacturing_fee": 123,
      "company_prices": [
        {
          "company_id": 1,
          "company_name": "Electronics Retailer Pro",
          "price": 91.99
        }
      ],
      "product_weight": 123,
      "product_length": 123,
      "product_width": 123,
      "product_height": 123,
      "qty_low_alert": 123,
      "qty_reorder_threshold": 123,
      "qty_minimum": 123,
      "sellable": true,
      "discontinued": true,
      "image_url": "<string>",
      "category": {
        "id": 123,
        "name": "<string>"
      },
      "subcategory": {
        "id": 123,
        "name": "<string>"
      },
      "custom_fields": {},
      "attachments": [
        {
          "id": 123,
          "name": "<string>",
          "type": "<string>",
          "size": 123,
          "full_url": "<string>",
          "thumb_url": "<string>"
        }
      ],
      "variants": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "attachments": [
            {
              "id": 123,
              "name": "<string>",
              "type": "<string>",
              "size": 123,
              "full_url": "<string>",
              "thumb_url": "<string>"
            }
          ],
          "retail_price": 123,
          "wholesale_price": 123,
          "company_prices": [
            {
              "company_id": 1,
              "company_name": "Electronics Retailer Pro",
              "price": 91.99
            }
          ],
          "custom_fields": [
            {}
          ],
          "variant_attributes": {},
          "sku": "<string>",
          "upc": "<string>",
          "sellable": true,
          "discontinued": true,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "variant_attributes": {},
      "sku": "<string>",
      "alternate_skus": [
        {
          "id": 123,
          "sku": "<string>"
        }
      ],
      "upc": "<string>",
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ],
      "substitutions": [
        {
          "id": 123,
          "priority": 123,
          "product": {
            "id": 123,
            "name": "<string>",
            "description": "<string>",
            "retail_price": 123,
            "wholesale_price": 123,
            "unit_cost": 123,
            "product_weight": 123,
            "product_length": 123,
            "product_width": 123,
            "product_height": 123,
            "sellable": true,
            "discontinued": true,
            "image_url": "<string>",
            "sku": "<string>",
            "upc": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "supplier": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

{
  "message": "<string>"
}

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

companyId

string

required

The unique identifier of the company

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

Successful response

data

object[]

Show child attributes

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Company Products

Available Filters

String Filters

Integer Filters

Float Filters

Boolean Filters

DateTime Filters

Examples

Authorizations

Path Parameters

Query Parameters

Response