Skip to main content
GET
/
products
/
api
/
v1
/
trade-items
List trade items
curl --request GET \
  --url https://www.closient.com/products/api/v1/trade-items \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "gtin": "<string>",
      "product_name": "<string>",
      "brand": "<string>",
      "manufacturer": "<string>",
      "description": "<string>",
      "image_url": "<string>",
      "country_of_origin": "<string>",
      "net_content": "<string>",
      "is_claimed": true,
      "confidence_score": 0.5,
      "primary_language": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "net_content_value": 123,
      "owner_id": "<string>",
      "countries_sold": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
brand
string | null

Limit to trade items whose brand name matches this string (exact, case-insensitive).

​
category_id
string | null

Limit to trade items in this ProductCategory (UUID).

​
is_claimed
boolean | null

When true, return only claimed GTINs; when false, return only unclaimed. Omit to return both.

​
country_of_origin
string | null

Limit to trade items whose country_of_origin matches this ISO 3166-1 alpha-2 code.

Maximum string length: 2
​
data_source
enum<string> | null

Limit to trade items whose canonical record came from this data source.

Available options:
crowd_sourced,
claimed,
imported,
ai_extracted,
brand_site_crawl,
gtin1_authoritative,
external_api,
open_food_facts,
usda_fdc,
fda_ndc,
affiliate_feed,
datakick,
common_crawl_wdc
​
q
string | null

Free-text search across product name and brand. Matches are case-insensitive substring matches.

​
ordering
string | null

Sort field; prefix with - for descending order. Allowed: product_name, brand, created, confidence_score.

​
page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
​
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

200 - application/json

OK

​
data
TradeItemOut · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

​
pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example:
{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}