Skip to content

ulams productables

Generated from front/cli (ulams schema)

Attach productable to user.

Kind: write. Stability: stable. MCP tool: productables_attach. Scopes: commerce:write.

Endpoints: POST /api/admin/productables/attach.

Flag Type Required Description
--productable-id integer yes
--productable-type string yes
--user-id integer yes
Terminal window
# Attach productable to user
ulams productables attach --productable-id text --productable-type text --user-id text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productable_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"productable_type": {
"type": "string"
},
"user_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"productable_id",
"productable_type",
"user_id"
],
"additionalProperties": {}
}

Detach product from user.

Kind: write. Stability: stable. MCP tool: productables_detach. Scopes: commerce:write.

Endpoints: POST /api/admin/productables/detach.

Flag Type Required Description
--productable-id integer yes
--productable-type string yes
--user-id integer yes
Terminal window
# Detach product from user
ulams productables detach --productable-id text --productable-type text --user-id text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productable_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"productable_type": {
"type": "string"
},
"user_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"productable_id",
"productable_type",
"user_id"
],
"additionalProperties": {}
}

Get list of all productables.

Kind: read (idempotent). Stability: stable. MCP tool: productables_list. Scopes: commerce:read.

Endpoints: GET /api/admin/productables/.

Terminal window
# Get list of all productables
ulams productables list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}

Get single product for this productable (if it exists).

Kind: read (idempotent). Stability: stable. MCP tool: productables_product. Scopes: commerce:read.

Endpoints: GET /api/admin/productables/product.

Flag Type Required Description
--productable-type string yes Productable class
--productable-id integer yes Productable id
Terminal window
# Get single product for this productable (if it exists)
ulams productables product --productable-type text --productable-id text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productable_type": {
"type": "string",
"description": "Productable class"
},
"productable_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Productable id"
}
},
"required": [
"productable_type",
"productable_id"
],
"additionalProperties": {}
}

List of registered Productable types.

Kind: read (idempotent). Stability: stable. MCP tool: productables_registered. Scopes: commerce:read.

Endpoints: GET /api/admin/productables/registered.

Terminal window
# List of registered Productable types
ulams productables registered --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}