API reference / Product API / Get Products

Get Products

Required headers: X-App-Key X-App-Secret X-Shop-Id

Returns the product catalog for the shop in the X-Shop-Id header. Use it to map TikTok product ids and seller SKUs to their cost data — each SKU carries price, cogs, and shippingCost, the inputs Kixmon uses to calculate net profit per order. Optional filters match part of a value and ignore case.

For how the headers work, refer to Authentication.

Version v1API Testing Tool

GEThttps://api.kixmon.io/api/v1/products

Request

Properties	Type	Description
`X-App-Key`Required	string	App key created when REST APIs are enabled in Settings. Example: `km_your_app_key`.
`X-App-Secret`Required	string	App secret created when REST APIs are enabled in Settings. Store it on your server only — never send it from a browser or mobile app.
`X-Shop-Id`Required	string	The shop to query. Get this id from Get Shops.

Query

Properties	Type	Description
`name`Optional	string	Filter by product name. Example: `serum`.
`productId`Optional	string	Filter by TikTok product id. Example: `1729384756102938`.
`skuName`Optional	string	Filter by seller SKU. Example: `SERUM-30ML`.
`skuId`Optional	string	Filter by SKU id. Example: `1729384756102940`.
`page`Optional	integer	Page number. Defaults to 1.
`limit`Optional	integer	Results per page. Defaults to 10, maximum 100.

Example

curl 'https://api.kixmon.io/api/v1/products?page=1&limit=10' \
  -H "X-App-Key: $KIXMON_APP_KEY" \
  -H "X-App-Secret: $KIXMON_APP_SECRET" \
  -H "X-Shop-Id: $KIXMON_SHOP_ID"

const res = await fetch("https://api.kixmon.io/api/v1/products?page=1&limit=10", {
  headers: {
    "X-App-Key": process.env.KIXMON_APP_KEY,
    "X-App-Secret": process.env.KIXMON_APP_SECRET,
    "X-Shop-Id": process.env.KIXMON_SHOP_ID,
  },
});
const data = await res.json();

import os, requests

resp = requests.get(
    "https://api.kixmon.io/api/v1/products",
    headers={
        "X-App-Key": os.environ["KIXMON_APP_KEY"],
        "X-App-Secret": os.environ["KIXMON_APP_SECRET"],
        "X-Shop-Id": os.environ["KIXMON_SHOP_ID"],
    },
    params={"page": 1, "limit": 10},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()

Response

Parameters

Properties	Type	Description
`success`	boolean	`true` when the request succeeds
`data`	object	Response payload
`items`	array	Products on this page
`id`	string	Product id
`productId`	string	TikTok product id
`name`	string	Product name
`icon`	string	Product image URL, or `null`
`status`	string	Product status, for example `ACTIVATE`
`skus`	array	SKUs for this product
`id`	string	SKU id
`sku`	string	Seller SKU
`price`	number	Selling price
`cogs`	number	Cost of goods sold
`shippingCost`	number	Shipping cost
`pagination`	object	Pagination details
`page`	integer	Current page number
`limit`	integer	Results per page
`total`	integer	Total matching results
`totalPages`	integer	Total number of pages

Example

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "6501aa...",
        "productId": "1729380000000000000",
        "name": "Logo Hoodie",
        "icon": "https://...",
        "status": "ACTIVATE",
        "skus": [
          {
            "id": "1729380000000000001",
            "sku": "HOODIE-BLK-M",
            "price": 29.99,
            "cogs": 8.5,
            "shippingCost": 2.1
          }
        ]
      }
    ],
    "pagination": { "page": 1, "limit": 10, "total": 1, "totalPages": 1 }
  }
}

Error Code

HTTP status	Code	Description
`400`	`INVALID_REQUEST`	A header or query parameter is invalid.
`401`	`MISSING_CREDENTIALS`	`X-App-Key` or `X-App-Secret` is missing.
`401`	`INVALID_CREDENTIALS`	App key or app secret is wrong.
`403`	`FEATURE_UNAVAILABLE`	REST APIs are not on the current plan.
`404`	`SHOP_NOT_FOUND`	Shop not found or not available for this app key.
`429`	`RATE_LIMITED`	More than 60 requests were sent in one minute for this app key, or the IP limit was reached. Wait, then retry.
`500`	`INTERNAL_ERROR`	An unexpected error occurred. Retry later.

Get Products

Request

Header

Query

Example

Response

Parameters

Example

Error Code

Resources

Features

Get in Touch