Skip to main content
GET
/
v1
/
products
List All Products
curl --request GET \
  --url https://api.trata.ai/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "id": "pro.1731301754.OZSMSU1S",
  "orgId": "org.1726902940.GZChqlpU",
  "active": true,
  "defaultPrice": 1299,
  "currency": "USD",
  "description": "Spicy Korean Chicken Wings",
  "name": "Spicy Korean Chicken Wings",
  "shippable": true,
  "features": [],
  "scheduleAppointment": false,
  "props": {},
  "status": "active",
  "createdBy": "trata-system",
  "createdAt": "2024-11-11T05:09:14.979287",
  "updatedBy": "trata-system",
  "updatedAt": "2024-11-11T05:09:14.979289"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
search_by
string | null

Field name to search by

​
search_value
string | null

Value to search for in the specified field

​
status
string | null

Filter by status

​
sort_by
string | null

Field to sort by

​
sort_order
enum<string> | null
default:asc

Sort order (asc or desc)

Available options:
asc,
desc
​
skip
integer
default:0

Number of records to skip

Required range: x >= 0
​
limit
integer
default:100

Maximum number of records to return

Required range: 1 <= x <= 100
​
tags
string[]

Filter products by specific tags

​
product_ids
string[]

Filter by specific product IDs

Response

List of products retrieved successfully

​
status
string
required
​
id
string
​
orgId
string
​
active
boolean
default:false

Product is active or not

​
defaultPrice
integer | null

Default price of the product this is represented in the lowest currency denomination. Eg: 1000 for $10

​
currency
string | null
​
description
string | null

Description of the product

Required string length: 1 - 256
​
name
string

Name of the product

Required string length: 1 - 256
​
shippable
boolean
default:false

Product is shippable or not. Service is not shippable

​
features
string[] | null

List of features of the product

​
scheduleAppointment
boolean
default:false

Product requires appointment scheduling or not

​
props
object | null

Properties of the product

​
tags
string[] | null
​
createdBy
string
​
createdAt
string<date-time>
​
updatedBy
string
​
updatedAt
string<date-time>
⌘I