Skip to main content
GET
/
products
/
company-pricing
All products with company pricing
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/products/company-pricing \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "retail_price": 123,
      "wholesale_price": 123,
      "unit_cost": 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
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
company_id
string

Filter pricing to specific company IDs. Can be a single ID or comma-separated list. If not provided, pricing for all active companies will be included.

​
page
integer
default:1

Page number for pagination

​
per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
​
q
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 company pricing information

​
data
object[]
​
meta
object