Appearance

Create Products ​

Endpoint ​

http
POST /unified/ecommerce/products
Integrations supported
  • Sage Intacct

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for a product

name
string

The name of a product

description
string

The description of a product

status
string

The status of a product. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • active
  • inactive
price
string

The price of a product

sku
string

The sku of a product

inventory_quantity
string

The quantity of a product in stock

images
object[]

The images of a product

id
string

The unique identifier of an image of a product

url
string

The url of an image of product

weight
string

The weight of a product

weight_unit
string

The weight unit of a product

options
object[]

The options of a product

id
string

The unique identifier of an option of a product

name
string

The name of option for product

values
array

The values of option for product

variants
object[]

The options of a product

id
string

The unique identifier of a variant of a product

name
string

The name of variant for product

price
string

The price of variant for product

sku
string

The sku of variant for product

inventory_quantity
string

The quantity of variant for product in stock

weight
string

The weight of variant

options
object[]

The options for variant

id
string

The unique identifier for option of variant

name
string

The name for option of variant

value
string

The value for option of variant

images
object[]

The images for variant

id
string

The unique identifier for image of variant

url
string

The url of image of variant

tags
string[]

The tags of a product

categories
object[]

The categories of a product

id
string

The unique identifier of a category of product

name
string

The name of category for product

created_at
string · date-time

The date and time when product was created

updated_at
string · date-time

The date and time when product was updated

notes
string

The notes related to the product, if any.

remote_data
object

Raw data returned from the remote API call.