Lectronz API Reference, Version 1
Products
JSON product representation
The product object represents a single product from a store, including all available options for that product. A product has one of the following statuses:
- draft: The product is in draft state and only visible to the seller.
- under_review: The seller has requested Lectronz to review this product before publication.
- reviewed: The product has been approved for publication. It is not listed publicly yet but can already be purchased through a dedicated private link.
- active: The product is publicly listed on Lectronz.
- retired: The product is no longer available for sale.
- pre_order: The product is part of a pre-order campaign (this feature is currently in beta-test).
This object has the following properties:
Unique identifier of the product.
Unique identifier of the store selling the product on Lectronz.
No description provided
Title of the product.
Product status.
Valid values are: draft, under_review, reviewed, active, retired, pre_order.
Base price of the product, excluding options.
Currency used for pricing.
Valid values are: EUR, USD.
URL slug for the product.
Product stock available, excluding further restrictions due to selected options.
Total number of units sold.
Optional unique identifier used by the seller to track inventory. Only provided if present.
A short description of the product (max 140 characters).
No description provided
See details
Link to documentation.
Link to source code.
Link to design files (KiCad, Eagle, etc.).
Link to schematics.
Link to bill of materials.
List of URLs of images of the product.
URL of product thumbnail.
Product weight.
Weight unit.
Valid values are: kg, gr, lb, oz.
Optional harmonized system code used throughout the export process for this product.
List of options available for the product.
See details
Unique identifier for this product option.
Name of the production option.
Description of the product option.
Ranking order of the product option as presented to the customer (lower goes first).
Available choices for the option.
See details
Unique identifier for this choice.
Name of this choice.
Price added or subtracted to the product price when this choice is selected.
Optional. Stock available for this choice.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this choice.
Ranking order of the choice as presented to the customer (lower goes first).
UTC publication date of product in ISO 8601 format (i.e. when the product reached active status).
UTC creation date of the product in ISO 8601 format.
UTC timestamp of last update of the product in ISO 8601 format.
Product URL.
Get product details
Request
Response body (object)
JSON product representation
details
Unique identifier of the product.
Unique identifier of the store selling the product on Lectronz.
No description provided
Title of the product.
Product status.
Valid values are: draft, under_review, reviewed, active, retired, pre_order.
Base price of the product, excluding options.
Currency used for pricing.
Valid values are: EUR, USD.
URL slug for the product.
Product stock available, excluding further restrictions due to selected options.
Total number of units sold.
Optional unique identifier used by the seller to track inventory. Only provided if present.
A short description of the product (max 140 characters).
No description provided
See details
Link to documentation.
Link to source code.
Link to design files (KiCad, Eagle, etc.).
Link to schematics.
Link to bill of materials.
List of URLs of images of the product.
URL of product thumbnail.
Product weight.
Weight unit.
Valid values are: kg, gr, lb, oz.
Optional harmonized system code used throughout the export process for this product.
List of options available for the product.
See details
Unique identifier for this product option.
Name of the production option.
Description of the product option.
Ranking order of the product option as presented to the customer (lower goes first).
Available choices for the option.
See details
Unique identifier for this choice.
Name of this choice.
Price added or subtracted to the product price when this choice is selected.
Optional. Stock available for this choice.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this choice.
Ranking order of the choice as presented to the customer (lower goes first).
UTC publication date of product in ISO 8601 format (i.e. when the product reached active status).
UTC creation date of the product in ISO 8601 format.
UTC timestamp of last update of the product in ISO 8601 format.
Product URL.
Update a product
This API call is currently limited to updating the value of the stock_available property of a product.
Request
Request body (object)
Request Body
details
Number of units of the product available for sale.
Response body (object)
JSON product representation
details
Unique identifier of the product.
Unique identifier of the store selling the product on Lectronz.
No description provided
Title of the product.
Product status.
Valid values are: draft, under_review, reviewed, active, retired, pre_order.
Base price of the product, excluding options.
Currency used for pricing.
Valid values are: EUR, USD.
URL slug for the product.
Product stock available, excluding further restrictions due to selected options.
Total number of units sold.
Optional unique identifier used by the seller to track inventory. Only provided if present.
A short description of the product (max 140 characters).
No description provided
See details
Link to documentation.
Link to source code.
Link to design files (KiCad, Eagle, etc.).
Link to schematics.
Link to bill of materials.
List of URLs of images of the product.
URL of product thumbnail.
Product weight.
Weight unit.
Valid values are: kg, gr, lb, oz.
Optional harmonized system code used throughout the export process for this product.
List of options available for the product.
See details
Unique identifier for this product option.
Name of the production option.
Description of the product option.
Ranking order of the product option as presented to the customer (lower goes first).
Available choices for the option.
See details
Unique identifier for this choice.
Name of this choice.
Price added or subtracted to the product price when this choice is selected.
Optional. Stock available for this choice.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this choice.
Ranking order of the choice as presented to the customer (lower goes first).
UTC publication date of product in ISO 8601 format (i.e. when the product reached active status).
UTC creation date of the product in ISO 8601 format.
UTC timestamp of last update of the product in ISO 8601 format.
Product URL.
Get the list of products in the store
Request
Response body (object)
Response Body
details
No description provided
No description provided
The total number of products.
No description provided
See details
Unique identifier of the product.
Unique identifier of the store selling the product on Lectronz.
No description provided
Title of the product.
Product status.
Valid values are: draft, under_review, reviewed, active, retired, pre_order.
Base price of the product, excluding options.
Currency used for pricing.
Valid values are: EUR, USD.
URL slug for the product.
Product stock available, excluding further restrictions due to selected options.
Total number of units sold.
Optional unique identifier used by the seller to track inventory. Only provided if present.
A short description of the product (max 140 characters).
No description provided
See details
Link to documentation.
Link to source code.
Link to design files (KiCad, Eagle, etc.).
Link to schematics.
Link to bill of materials.
List of URLs of images of the product.
URL of product thumbnail.
Product weight.
Weight unit.
Valid values are: kg, gr, lb, oz.
Optional harmonized system code used throughout the export process for this product.
List of options available for the product.
See details
Unique identifier for this product option.
Name of the production option.
Description of the product option.
Ranking order of the product option as presented to the customer (lower goes first).
Available choices for the option.
See details
Unique identifier for this choice.
Name of this choice.
Price added or subtracted to the product price when this choice is selected.
Optional. Stock available for this choice.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this choice.
Ranking order of the choice as presented to the customer (lower goes first).
UTC publication date of product in ISO 8601 format (i.e. when the product reached active status).
UTC creation date of the product in ISO 8601 format.
UTC timestamp of last update of the product in ISO 8601 format.
Product URL.