Sign in

v1

latestOpenAPI 3.0.32026-07-12254440.6 KB
Product

getProduct

Read a specific product entity by a given id

get/v1/product/{productId}

Path parameters

productIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The product id

Query parameters

hydrateboolean

Hydrates entities in relations when passed true

strictboolean

When passed true, the response will contain only fields that match the schema, with non-matching fields included in __additional

Response

Product entity response

_idstring uuid
_schema'product' required
_orgstring required

Organization Id the entity belongs to

_tagsstring[] nullable
_titlestring
_created_atstring date-time
_updated_atstring date-time
activeboolean required
namestring required

The description for the product

categoriesstring[]

The categories of the product

internal_namestring

Not visible to customers, only in internal tables

codestring

The product code

type'product' | 'service' required

The type of Product:

typedescription
productRepresents a physical good
serviceRepresents a service or virtual product
descriptionstring

A description of the product. Multi-line supported.

_purposestring[] nullable
_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_acl": {
    "view": [
      "org:456"
    ],
    "edit": [
      "org:456"
    ],
    "delete": [
      "org:456"
    ]
  },
  "price_options": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "product_images": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "product_downloads": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_availability_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}