Products

Update a Specific Product by ID

put/v1/products/{product_id}

Request

Base URL
https://api.trata.ai
URL
https://api.trata.ai/v1/products/{product_id}
Auth
HTTP bearer

Path parameters

product_idstring required

ID of the product

Request body

activeboolean required

Product is active or not

defaultPriceinteger required

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

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

Currency of the product

descriptionstring required

Description of the product

namestring required

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

Tags for the product. This is used for grouping purpose. Eg: ["gardening", "tools"]

status'active' | 'inactive' required

agentIdsstring[] nullable

List of agent ids which are accessible for this product

Example request

{
  "description": "High-quality gardening tools",
  "name": "Garden Tool Set"
}

Response

Product updated 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.