Product Management APIs

The Product Management APIs provide a comprehensive set of endpoints for managing products, their variants, and associated barcodes in the Spaaza system. These APIs support the full lifecycle of product management including creation, retrieval, updates, and deletion.

Core Concepts

The product management system is built around three key entities that have specific relationships:

Products

Products are the main entities that represent items in your inventory. Each product:

• Contains basic information like name, description, brand, and base price
• Is identified by a unique owner_code within a chain
• Can have multiple variants to represent different versions of the same product
• Belongs to a specific chain and requires appropriate permissions to manage

Product Variants

Product variants represent specific variations of a base product. Each variant:

• Is associated with exactly one parent product
• Can have unique attributes like:
  • Size (e.g., S, M, L, XL)
  • Color (e.g., red, blue, green)
  • Price (which can differ from the base product price)
  • Condition (e.g., new, used)
• Can have one or more barcodes for identification
• Inherits certain properties from its parent product (e.g., brand, description)

Barcodes

Barcodes are unique identifiers that are:

• Always associated with a specific product variant
• Used for inventory tracking and point-of-sale operations
• Can be in various formats (e.g., EAN-13, UPC)
• Must be unique within a chain

Entity Relationships

1. A Product can have multiple Product Variants (one-to-many relationship)
2. A Product Variant belongs to exactly one Product (many-to-one relationship)
3. A Product Variant can have multiple Barcodes (one-to-many relationship)
4. A Barcode belongs to exactly one Product Variant (many-to-one relationship)

Available Endpoints

Product Management

• Add Product - Create or update a product
• Get Product - Retrieve product details
• Delete Product - Delete a product and its variants

Product Variant Management

• Add Product Variant - Create or update a product variant
• Get Product Variants - Retrieve product variants
• Delete Product Variant - Delete a product variant

Barcode Management

• Delete Barcode - Delete a barcode

Alternative Product Creation

Products can also be created automatically through the add-basket endpoint. This method allows for dynamic product creation during basket operations, which can be useful for integrating with point-of-sale systems or e-commerce platforms.

Common Operations

1. Creating a new product with variants:
   • First create the product using Add Product
   • Then create variants using Add Product Variant
   • Each variant can include one or more barcodes
2. Updating existing products:
   • Use Add Product with update_if_exists=true to update product details
   • Use Add Product Variant with update_if_exists=true to update variant details
3. Retrieving product information:
   • Use Get Product to retrieve a specific product and its variants
   • Use Get Product Variants to search for variants by barcode or list all variants
4. Removing products:
   • Use Delete Product to remove a product and all its variants
   • Use Delete Product Variant to remove a specific variant
   • Use Delete Barcode to remove a specific barcode from a variant

---

Table of contents

• Add Product
• Add Product Variant
• Delete Barcode
• Delete Product
• Delete Product Variant
• Get Product
• Get Product Variants