Products

List All Products

List All Products

get/v1/products

Request

  • Base URL
    https://api.trata.ai
  • URL
    https://api.trata.ai/v1/products
  • Auth
    HTTP bearer

Query parameters

search_bystring nullable

Field name to search by

search_valuestring nullable

Value to search for in the specified field

statusstring nullable

Filter by status

sort_bystring nullable

Field to sort by

sort_order'asc' | 'desc'

Sort order (asc or desc)

skipinteger

Number of records to skip

limitinteger

Maximum number of records to return

tagsstring[]

Filter products by specific tags

product_idsstring[]

Filter by specific product IDs

Response

List of products retrieved successfully

idstring
orgIdstring
activeboolean

Product is active or not

defaultPriceinteger nullable

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

currencystring nullable
descriptionstring nullable

Description of the product

namestring

Name of the product

shippableboolean

Product is shippable or not. Service is not shippable

featuresstring[] nullable

List of features of the product

scheduleAppointmentboolean

Product requires appointment scheduling or not

propsobject nullable

Properties of the product

tagsstring[] nullable
statusstring required
createdBystring
createdAtstring date-time
updatedBystring
updatedAtstring date-time

Changes

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