apigetproducts JSON request body list or single

POST /api/getproducts lists products or returns one product by id or sku. POST /api/getproduct remains available for single-product lookup.

Fields

key

string, required

Your API key.

id, sku

optional single lookup

When provided, returns one product instead of a paginated list.

deleted, category, visibility, status, search

optional filters

deleted accepts numeric or string booleans and defaults to 0. Search checks product name, SKU, and descriptions.

include or expand

comma string or array, optional

Allowed expansions: images, attributes, variations, or all. Expansions are skipped unless requested to keep list responses lighter.

page, step, orderby, order

optional pagination and sorting

step is capped at 100. Allowed order fields: id, name, sku, price, created_at, updated_at, status, visibility.

{
  "key": "YOUR_API_KEY",
  "search": "TERRAX",
  "deleted": 0,
  "include": "images,attributes,variations",
  "page": 1,
  "step": 20
}

{
  "key": "YOUR_API_KEY",
  "sku": "TERRAX-40",
  "expand": "all"
}

images_data contains gallery image rows.
feature_values contains product feature values with their feature definitions.
variations_data contains variations with their feature-value combinations.
JSON fields such as variation_features, preset_features, step2_visibility_rules, type45_select_modes, and type45_required_features are decoded when possible.

/api/createproduct is the primary create/update upsert endpoint. /api/editproduct is legacy/minimal.