Skip to main content
GET
/
api
/
workspace
/
{workspaceId}
/
catalog
/
products
List products
curl --request GET \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/catalog/products \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "cursor": "<string>",
    "has_more": true
  }
}

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

Query Parameters

catalog_id
string

Filter by catalog ID

brand
string
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string

Response

Products retrieved successfully

data
object[]
pagination
object