Adding or Updating a Product

Contents

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

Overview

• Call name: add-product
• Endpoint URL: https://api0.spaaza.com/internal/add-product
• 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 or updating an existing product in the Spaaza system. When creating a new product, it will be automatically assigned to the default category (ID 1). When updating an existing product, only the provided fields will be updated.

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 HTTP/1.1
Content-Type: application/json

{
    "chain_id": 123,
    "name": "Men's Merino Aran Jumper",
    "description": "The Aran Jumper is a style of jumper that takes its name from the Aran Islands off the west coast of Ireland.",
    "price": 99.95,
    "cost_price": 79.95,
    "owner_code": "00024003",
    "brand": "Aran Brands Inc.",
    "image_url": "https://www.spaaza.com/images/arran.jpg",
    "webshop_url": "https://www.shop.spaaza.com/images/arran.jpg",
    "season": "Winter",
    "category": "sweater > Aran > mens",
    "is_promotional": false
}

Sample response

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "product": {
            "brand": "Aran Brands Inc.",
            "category": "sweater > Aran > mens",
            "cost_price": 79.95,
            "created_date": "2025-01-24T12:00:00+00:00",
            "description": "The Aran Jumper is a style of jumper that takes its name from the Aran Islands off the west coast of Ireland.",
            "id": 456,
            "image_url": "https://www.spaaza.com/images/arran.jpg",
            "last_modified_date": "2025-01-24T12:00:00+00:00",
            "name": "Men's Merino Aran Jumper",
            "owner_code": "00024003",
            "price": 99.95,
            "season": "Winter",
            "webshop_url": "https://www.shop.spaaza.com/images/arran.jpg"
        },
        "result_type": "add-product"
    }
}

Possible error responses