Skip to main content
POST
/
api
/
workspace
/
{workspaceId}
/
catalog
/
products
Create product
curl --request POST \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/catalog/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "price": 1,
  "catalog_id": "<string>",
  "description": "<string>",
  "brand": "<string>",
  "category_path": [
    "<string>"
  ],
  "original_price": 1,
  "currency": "USD",
  "primary_image_url": "<string>",
  "sku": "<string>",
  "gtin": "<string>",
  "availability": "in_stock",
  "attributes": {}
}
'
{
  "id": "<string>",
  "workspaceId": "<string>",
  "title": "<string>",
  "price": 123,
  "currency": "<string>",
  "availability": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "catalogId": "<string>",
  "description": "<string>",
  "brand": "<string>",
  "categoryPath": [
    "<string>"
  ],
  "originalPrice": 123,
  "primaryImageUrl": "<string>",
  "sku": "<string>",
  "gtin": "<string>",
  "attributes": {},
  "optimizationScore": 50,
  "feedReady": true,
  "createdBy": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Obtain a token via the authentication endpoint and include it in the Authorization header: Authorization: Bearer <token>

Path Parameters

workspaceId
string
required

The workspace ID

Body

application/json
title
string
required
Required string length: 1 - 500
price
number
required
Required range: x >= 0
catalog_id
string | null
description
string | null
Maximum string length: 5000
brand
string | null
category_path
string[]
original_price
number | null
Required range: x >= 0
currency
string
default:USD
primary_image_url
string<uri> | null
sku
string | null
gtin
string | null
availability
string
default:in_stock
attributes
object

Response

Product created successfully

id
string
required
workspaceId
string
required
title
string
required
price
number<float>
required
currency
string
required
availability
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
catalogId
string | null
description
string | null
brand
string | null
categoryPath
string[]
originalPrice
number<float> | null
primaryImageUrl
string<uri> | null
sku
string | null
gtin
string | null
attributes
object
optimizationScore
integer

Product optimization score (0-100)

Required range: 0 <= x <= 100
feedReady
boolean

Whether product is ready for feed export

createdBy
string