Products

Product management operations

Create

POST/products

List

GET/products

Retrieve

GET/products/{code}

ModelsExpand Collapse

Product object { id, code, created, 3 more }

Product object.

id: string

FRAGMENT generated unique ID.

code: string

Product code.

created: string

Timestamp when the product was created. Uses ISO 8601 format.

formatdate-time

update_version: number

Current version of the product.

workspace_id: string

Workspace ID of the product.

description: optional string

Product description.

ProductCreateResponse object { data }

data: Product { id, code, created, 3 more }

Product object.

id: string

FRAGMENT generated unique ID.

code: string

Product code.

created: string

Timestamp when the product was created. Uses ISO 8601 format.

formatdate-time

update_version: number

Current version of the product.

workspace_id: string

Workspace ID of the product.

description: optional string

Product description.

ProductListResponse object { data }

data: array of Product { id, code, created, 3 more }

List of products.

id: string

FRAGMENT generated unique ID.

code: string

Product code.

created: string

Timestamp when the product was created. Uses ISO 8601 format.

formatdate-time

update_version: number

Current version of the product.

workspace_id: string

Workspace ID of the product.

description: optional string

Product description.

ProductRetrieveResponse object { data }

data: Product { id, code, created, 3 more }

Product object.

id: string

FRAGMENT generated unique ID.

code: string

Product code.

created: string

Timestamp when the product was created. Uses ISO 8601 format.

formatdate-time

update_version: number

Current version of the product.

workspace_id: string

Workspace ID of the product.

description: optional string

Product description.