Skip to content
FRAGMENT
API Reference

Products

Product management operations

Create
products.create(ProductCreateParams**kwargs) -> ProductCreateResponse
POST/products
List
products.list() -> ProductListResponse
GET/products
Retrieve
products.retrieve(strcode) -> ProductRetrieveResponse
GET/products/{code}
ModelsExpand Collapse
class Product: …

Product object.

id: str

FRAGMENT generated unique ID.

code: str

Product code.

created: datetime

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

formatdate-time
update_version: float

Current version of the product.

workspace_id: str

Workspace ID of the product.

description: Optional[str]

Product description.

class ProductCreateResponse: …
data: Product

Product object.

id: str

FRAGMENT generated unique ID.

code: str

Product code.

created: datetime

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

formatdate-time
update_version: float

Current version of the product.

workspace_id: str

Workspace ID of the product.

description: Optional[str]

Product description.

class ProductListResponse: …
data: List[Product]

List of products.

id: str

FRAGMENT generated unique ID.

code: str

Product code.

created: datetime

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

formatdate-time
update_version: float

Current version of the product.

workspace_id: str

Workspace ID of the product.

description: Optional[str]

Product description.

class ProductRetrieveResponse: …
data: Product

Product object.

id: str

FRAGMENT generated unique ID.

code: str

Product code.

created: datetime

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

formatdate-time
update_version: float

Current version of the product.

workspace_id: str

Workspace ID of the product.

description: Optional[str]

Product description.