Create a product

POST /products

Create a product

cURL

curl --request POST \
  --url https://api.sentralbee.app/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "type": "<string>",
  "description": "<string>",
  "category": "<string>",
  "requires_shipping": true,
  "can_preorder": true,
  "total_stock": 123,
  "price_range": {},
  "media": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "thumbnail": "<string>",
      "type": "<string>",
      "position": 123
    }
  ],
  "variants": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sku": "<string>",
      "stock": 123,
      "price": {},
      "attributes": {}
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Workspace API key. The workspace is derived from the key.

Body

application/json

Product creation payload. name is required; additional fields (variants, media, options, pricing) are accepted — see the guides for the full shape.

name · string · required

Response

201

application/json

Created product

id · string<uuid> · required

name · string · required

status · string · required

type · string · required

description · string

category · string

requires_shipping · boolean

can_preorder · boolean

total_stock · integer

price_range · object

Show child attributes

media · object[]

Show child attributes

variants · object[]

Show child attributes

created_at · string<date-time>

updated_at · string<date-time>