logo
Welcome
API Reference
Search products
Get product info by UUID
Get product info by GTIN
Get product info by SKU
Get product info by external_id
Sign in

Product Lookup API

Search for products via identifiers, view the product status and basic information.

This API allows you to look up individual products using one of the following:

  1. SmarterX product ID (UUID)
  2. GTIN
  3. SKU
  4. Custom identifier (external_id)
BASE URL
https://boss-test.smarterx.com

Search products

Search for products using either GTIN or SKU. Must provide at least one.

Return matching products with basic information, including uuids that can be used to retrieve additional information

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

gtin

array of strings

GTIN of a product. 8, 12, 13, or 14 digits in length. More than one may be provided in a space or comma-separated list.

sku

array of strings

Product SKU (format may vary. More than one may be provided in a space or comma-separated list.

external_id

array of strings

Customer identifier(format may vary). More than one may be provided in a space or comma-separated list.

GET
/v1/lookup
1

Get product info by UUID

Returns basic information about a product.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

product_id

required, string

SmarterX uuid for a product

GET
/v1/lookup/:product_id
1

Get product info by GTIN

Returns basic information about a product looked up on GTIN-14.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

gtin

required, string

GTIN of a product. 8, 12, 13, or 14 digits in length

GET
/v1/lookup/by_gtin/:gtin
1

Get product info by SKU

Returns basic information about a product looked up on SKU.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

sku

required, string

SKU of a product

GET
/v1/lookup/by_sku/:sku
1

Get product info by external_id

Returns basic information about a product looked up on external_id.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

external_id

required, string, maximum length of 128

Customers unique identifier for a product

GET
/v1/lookup/by_external_id/:external_id
1