Products

Create

Creates a product.

POST /products
const response = await client.products.create(
  {
    code: 'PROD_001',
    description: 'Premium subscription service'
  }
);
Parameters
NameDescription
codestring, required

Unique product code.

descriptionstring

Product description.

Response
NameDescription
dataobject

Product object.

{
  "data": {
    "id": "product_1234567890",
    "workspace_id": "ws_1234567890",
    "code": "PROD_001",
    "description": "Premium subscription service",
    "update_version": 1,
    "created": "2024-01-13T00:00:00Z"
  }
}

List

Lists all products.

GET /products
const response = await client.products.list();
Response
NameDescription
dataobject[]

List of products.

{
  "data": [
    {
      "id": "product_1234567890",
      "workspace_id": "ws_1234567890",
      "code": "PROD_001",
      "description": "Premium subscription service",
      "update_version": 1,
      "created": "2024-01-13T00:00:00Z"
    }
  ]
}

Retrieve

Retrieves a product by code.

GET /products/{code}
const response = await client.products.retrieve('PROD_001');
Parameters
NameDescription
codestring, required

Product code. Must not include #, /, or :.

Response
NameDescription
dataobject

Product object.

{
  "data": {
    "id": "product_1234567890",
    "workspace_id": "ws_1234567890",
    "code": "PROD_001",
    "description": "Premium subscription service",
    "update_version": 1,
    "created": "2024-01-13T00:00:00Z"
  }
}