Find a product in the authenticated account by exact equality on code or SKU, including variants when includes_variants is true. Uses Products directly, not the search index. Send barcode as text to preserve leading zeros. Products trims/removes whitespace and null characters, strips surrounding square/curly brackets and uppercases the input; equality follows database collation. This is not a substring search or a GTIN validator. reference is not searched. Returns the Product resource with all its variants, not a selected variant ID. Inactive products can be returned. If multiple records match, the existing receiver returns its first match without an ambiguity guarantee. Unknown or foreign-account-only codes return 404; there is no fallback to Search.
Query Parameters
Barcode or SKU as text, for example 001234. URL-encode special characters. No account selector or request body.
Header Parameters
Your API Key for authentication
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/products/lookup?barcode=string" \ -H "X-Api-Key: string"{ "id": "string", "account_id": "string", "name": "string", "description": "string", "characteristics": "string", "sku": "string", "code": "string", "reference": "string", "slug": "string", "base_price": 0, "price": 0, "price_2": 0, "price_3": 0, "price_4": 0, "price_5": 0, "price_6": 0, "price_7": 0, "price_8": 0, "price_9": 0, "price_10": 0, "cost_weighted_average": 0, "cost_base_weighted_average": 0, "cost_average": 0, "cost_base_average": 0, "cost_last_purchase": 0, "cost_base_last_purchase": 0, "last_purchase_date": "2019-08-24T14:15:22Z", "cost_updated_at": "2019-08-24T14:15:22Z", "purchase_count": 0, "purchase_quantity": 0, "item_width": 0, "item_length": 0, "item_height": 0, "item_weight": 0, "measurement": "string", "category_id": "string", "custom_category_id": "string", "custom_category": { "id": "string", "name": "string", "sort_index": 0, "created_at": "2019-08-24T14:15:22Z", "category_parent_id": "string", "account_id": "string", "image": "string" }, "reference_category": "string", "status": "string", "internal_status": "string", "type": "string", "ecommerce_status": "string", "control_inventory": true, "available_online": true, "hide_in_catalog": true, "fast_shipping": true, "is_raw_material": true, "variants": [ { "id": "string", "code": "string", "sku": "string", "base_price": 0, "price": 0, "price_2": 0, "price_3": 0, "price_4": 0, "price_5": 0, "price_6": 0, "price_7": 0, "price_8": 0, "price_9": 0, "price_10": 0, "options": [ { "name": "string", "value": "string" } ] } ], "includes_variants": true, "includes_serials": true, "includes_optionals": true, "includes_features": true, "hide_childs_in_ecommerce": true, "variant_image_for_option": "string", "variants_in_groups": "string", "variant_options_line": "string", "profile_picture": "string", "images": [ {} ], "files": [ {} ], "custom_fields": { "property1": "string", "property2": "string" }, "search_engine_title": "string", "search_engine_description": "string", "total_sale_total_price_sum": 0, "total_sale_price_sum": 0, "total_sale_count": 0, "total_sale_stock_sum": 0, "sale_weighted_average": 0, "sale_average_cost": 0, "last_sale_price": 0, "last_sale_date": "2019-08-24T14:15:22Z", "accumulated_sales": 0, "review_rating": 0, "review_count": 0, "supplier_id": "string", "supplier_estimated_delivery_time": 0, "is_parent": true, "has_taxes": true, "has_discounts": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": "string", "updated_by": "string"}Create product POST
Create a product in the account associated with the API key. name and custom_category_id are required; the category must belong to that account. Use optional tax_ids with IDs from GET /v1/taxes to associate existing taxes from this account. Omitted, null or [] creates without taxes; has_taxes is derived, not an input. Unknown or foreign tax IDs return 404. Optional variants creates the supplied combinations with code, sku, base_price, price, price_2 through price_10 and options [{name,value}]. Use the same option names and order for every variant. No IDs, stock or calculated costs are accepted for variants. includes_variants is derived from the list; is_parent refers to composite products, not variant ownership. Do not send account_id or a product ID. This operation is not idempotent; reconcile an uncertain result before retrying.
Get Product By Id GET
**Get a product by ID.**