Definition

Products

Products are references to items in your external OMS, including their destination, content, and image.

Response blueprint

Fields returned for this resource. Expand nested objects to inspect their fields.

array of objects — item fields

idinteger
sourcestring
The source for this resource.
external_idstring | null
Identifier for the related external.
titlestring
The title for this resource.
urlstring
URL for url.
html_descriptionstring | null
The html description for this resource.
image_urlstring | null
URL for image.
activeboolean
The active for this resource.
The variants for this resource.
- idinteger
- external_idstring
  Identifier for the related external.
- titlestring
  The title for this resource.
- skustring | null
  The sku for this resource.
- image_urlstring | null
  URL for image.
- pricestring | null
  Price in the authenticated shop's configured currency.
- activeboolean
  The active for this resource.
- The options for this resource.
  namestring
  Human-readable name for this resource.
  valuestring
  The value for this resource.

Endpoints

GETList products/api/v1/productsGETFetch product/api/v1/products/{id}POSTUpsert product/api/v1/products