Skip to content
On this page

Product API Reference

Product characteristics

Products can be configured with characteristics. Characteristics are defined outside of the product and can used during the configuration of different products.

Product options

Products can have options. Options are used to differenciate products having the same definition. For instance, a product color or a product size are options of the same base product. Options are defined outside of the product and can used during the configuration of different products.

Product definition

Product definition is product metadata that defines core non variables elements of a product. For instance a t-shirt is a basic product definition. A product definition has no variants attached. It contains basic characteristiques, core attributes and dynamic attributes.

Product

Product definition returns product summary usefull when working on a product management perspective. Product api returns complete object with composition rules and should be used when listing products or getting product details.

Product properties (attributes)

Properties (attributes) adds extension to the product core attributes by allowing the creation of custom properties (attributes).

Product variations (options)

Variations of product definitions.

Product variants

Product variants are product definitions with variations attached to it. A single product definition can have multiple product variants. Each product variant has its own sku.

Product classification

Products are classified in Category.

List products

List products with pagination and filters for a specific Merchant Store and Language.

Search products

Full Text search and Auto complete keywords using Search server such as Elastic Search and Open Search

Swagger documentations

All apis are described on Swaggerhub Shopizer repository

Shopize Swagger Documentationhttps://app.swaggerhub.com/apis-docs/shopizer/shopizer-rest-api/3.0.1