Adding or Updating a Product Variant

Contents

• Overview
• Version-specific information
• Permissions and Authentication
• Headers
• HTTP Parameters
• Sample request
• Sample response
• Possible error responses

Overview

• Call name: add-product-variant
• Endpoint URL: https://api0.spaaza.com/internal/add-product-variant
• Request methods: POST
• Request Content-Type: application/json or application/x-www-form-urlencoded
• Response Content-Type: application/json
• Auth required: yes

This endpoint allows creating a new product variant or updating an existing one in the Spaaza system. A product variant represents a specific variation of a product (e.g., different size, color) and can have its own barcodes, price, and other attributes.

Version-specific information

The following version-specific changes apply to this endpoint. See the versioning page for more details.

Permissions and Authentication

This API call requires admin authentication:

• The performing user must be logged in and have WRITE access to the specified chain
• User and privileged authentication methods are not permitted for this endpoint

Headers

Standard headers are used for this endpoint. No special headers are required.

HTTP Parameters

The following HTTP parameters can be passed to the API:

Sample request

POST /internal/add-product-variant HTTP/1.1
Content-Type: application/json

{
    "chain_id": 123,
    "product_id": 456,
    "colour": "navy",
    "price": 99.95,
    "cost_price": 79.95,
    "image_url": "https://www.spaaza.com/images/navy_arran.jpg",
    "web_url": "https://www.shop.spaaza.com/images/navy_arran.jpg",
    "size": "S",
    "barcodes": ["2000042436019", "2000042436018"],
    "is_promotional": false
}

Sample response

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "product_variant": {
            "barcodes": [
                {
                    "barcode": "2000042436019",
                    "created_date": "2025-01-24T12:00:00+00:00",
                    "deleted": false,
                    "id": 3,
                    "last_modified_date": "2025-01-24T12:00:00+00:00",
                    "product_variant_id": 3
                }
            ],
            "colour": "navy",
            "condition": "new",
            "cost_price": 79.95,
            "currency_id": 2,
            "id": 3,
            "image_url": null,
            "name": null,
            "price": 99.95,
            "product_id": 456,
            "published_expiry_date": "2025-02-23T12:00:00+00:00",
            "published_status": 1,
            "size": "S",
            "web_url": null
        },
        "result_type": "add-product-variant"
    }
}

Possible error responses