Single product with company pricing

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

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/products/{productId}/company-pricing"

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/products/{productId}/company-pricing', 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/products/{productId}/company-pricing",
  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/products/{productId}/company-pricing"

	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/products/{productId}/company-pricing")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/products/{productId}/company-pricing")

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"
  }
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource",
  "status_code": 403
}

{
  "message": "<string>"
}

Product Pricing

Single product with company pricing

Retrieve a single product by ID with pricing calculated for all active companies or filtered by specific company IDs. This provides comprehensive pricing information for the product across multiple companies in a single request.

The product will include a company_prices array containing pricing for each company based on their assigned price levels, price groups, and applicable discounts or markups.

This endpoint returns complete product information including variants, substitutions, custom fields, and tags, with company pricing calculated for both the main product and any variants.

Pricing Calculation

The pricing system considers multiple factors for each company:

Price Levels: Standard, Premium, VIP, Wholesale, etc.
Price Groups: Customer segments like “Electronics Retailers”, “Bulk Distributors”
Category Rules: Different pricing rules can apply to different product categories
Markups/Discounts: Percentage increases or decreases based on customer type

Company Filtering

Use the company_id parameter to filter pricing to specific companies:

Single company: ?company_id=1
Multiple companies: ?company_id=1,2,3

Example Response

The response includes all standard product fields plus the company_prices array:

{
  "data": {
    "id": 1,
    "name": "Test Product 1",
    "sku": "SKU-001",
    "retail_price": 99.99,
    "wholesale_price": 79.99,
    "company_prices": [
      {
        "company_id": 1,
        "company_name": "Electronics Retailer Pro",
        "price": 91.99
      },
      {
        "company_id": 2,
        "company_name": "Bulk Distribution Corp", 
        "price": 63.99
      }
    ],
    "variants": [
      {
        "id": 2,
        "name": "Test Product 1 - Large",
        "sku": "SKU-001-L",
        "company_prices": [
          {
            "company_id": 1,
            "company_name": "Electronics Retailer Pro",
            "price": 101.99
          }
        ]
      }
    ]
  }
}

GET

products

{productId}

company-pricing

Single product with company pricing

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

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/products/{productId}/company-pricing"

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/products/{productId}/company-pricing', 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/products/{productId}/company-pricing",
  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/products/{productId}/company-pricing"

	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/products/{productId}/company-pricing")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/products/{productId}/company-pricing")

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"
  }
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource",
  "status_code": 403
}

{
  "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

productId

integer

required

The ID of the product to retrieve

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.

Response

Product with company pricing information

data

object

Show child attributes

All products with company pricing BOMs

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Single product with company pricing

Pricing Calculation

Company Filtering

Example Response

Authorizations

Path Parameters

Query Parameters

Response