commerce

Create a product

Add a product to the shop.

price is in rands and is stored as cents (price_cents), rounded to the nearest cent.

Omit stock_quantity to leave stock untracked; the storefront then never shows a sold-out state for it.

sku is unique per organization; a duplicate returns 409.

images is the product's gallery in order, up to 12; the first is the cover, shown on the shop shelf, and image_url always repeats it. Each image needs an https url and alt text (a short description, up to 250 characters). An image you uploaded with the upload call also sends its path, which must be your own business's file.

Send images or image_url (one cover image), never both. Blueticked never fetches an image link; it only shows it.

post/api/v1/commerce/products

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/commerce/products
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring
pricenumber
skustring
stock_quantitynumber
image_urlstring nullable

One cover image (https). Not with images.

Example request

{
  "name": "Fynbos gift hamper",
  "description": "Local honey, rooibos and a proudly SA snack selection.",
  "price": 199.5,
  "sku": "HAMPER-01",
  "stock_quantity": 14
}

Response

Success

okboolean required

Example response

{
  "ok": true,
  "product": {
    "id": "289e49ce-dfbc-4347-9b4c-52f001f009c3",
    "name": "Fynbos gift hamper",
    "currency": "ZAR",
    "images": [
      {
        "url": "https://example.com/hamper.jpg",
        "alt": "The hamper, wrapped in kraft paper"
      }
    ],
    "source": "blueticked",
    "is_active": true,
    "created_at": "2026-07-20T10:00:00.000Z",
    "variants": [
      {
        "id": "d37404e6-905e-48f7-9c9f-39cb178ba224",
        "name": "Large",
        "is_active": true
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.