Products

get_products

Get list of products for the authenticated user's organization

get_products

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_products",
    "arguments": {
        "data": {
          "relations": [
            "string"
          ],
          "findInput": {
            "enabled": true,
            "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
            "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
          }
        },
        "page": 0,
        "limit": 0
      }
  }
}

const result = await client.callTool({
  "name": "get_products",
  "arguments": {
    "data": {
      "relations": [
        "string"
      ],
      "findInput": {
        "enabled": true,
        "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
        "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
      }
    },
    "page": 0,
    "limit": 0
  }
});

result = await session.call_tool("get_products", arguments={
  "data": {
    "relations": [
      "string"
    ],
    "findInput": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
      "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
    }
  },
  "page": 0,
  "limit": 0
})

Request Body

{
  "data": {
    "relations": [
      "string"
    ],
    "findInput": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
      "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
    }
  },
  "page": 0,
  "limit": 0
}

Body

application/json

dataobject

Query data object

Show child attributes

relationsArray<string>

Relations to include (e.g., ["productType", "productCategory", "tags"])

findInputobject

Find input filters

Show child attributes

enabledboolean

productCategoryIdstring<uuid>

productTypeIdstring<uuid>

[key: string]any

pagenumber

Page number for pagination

limitnumber

Number of items per page

get_products_translated

Get list of products with translations for a specific language

get_products_translated

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_products_translated",
    "arguments": {
        "langCode": "string",
        "data": {
          "relations": [
            "string"
          ],
          "findInput": {
            "enabled": true,
            "productCategoryId": "550e8400-e29b-41d4-a716-446655440000"
          }
        },
        "page": 0,
        "limit": 0
      }
  }
}

const result = await client.callTool({
  "name": "get_products_translated",
  "arguments": {
    "langCode": "string",
    "data": {
      "relations": [
        "string"
      ],
      "findInput": {
        "enabled": true,
        "productCategoryId": "550e8400-e29b-41d4-a716-446655440000"
      }
    },
    "page": 0,
    "limit": 0
  }
});

result = await session.call_tool("get_products_translated", arguments={
  "langCode": "string",
  "data": {
    "relations": [
      "string"
    ],
    "findInput": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000"
    }
  },
  "page": 0,
  "limit": 0
})

Request Body

{
  "langCode": "string",
  "data": {
    "relations": [
      "string"
    ],
    "findInput": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000"
    }
  },
  "page": 0,
  "limit": 0
}

Body

application/json

langCodestringrequired

Language code for translations (e.g., "en", "fr", "es")

dataobject

Query data object

Show child attributes

relationsArray<string>

Relations to include

findInputobject

Find input filters

Show child attributes

enabledboolean

productCategoryIdstring<uuid>

pagenumber

Page number for pagination

limitnumber

Number of items per page

get_product_count

Get product count in the authenticated user's organization

get_product_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_product_count",
    "arguments": {
        "data": {
          "findInput": {
            "enabled": true,
            "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
            "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
          }
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_product_count",
  "arguments": {
    "data": {
      "findInput": {
        "enabled": true,
        "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
        "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  }
});

result = await session.call_tool("get_product_count", arguments={
  "data": {
    "findInput": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
      "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
})

Request Body

{
  "data": {
    "findInput": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
      "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
}

Body

application/json

dataobject

Query data object

Show child attributes

findInputobject

Find input filters

Show child attributes

enabledboolean

productCategoryIdstring<uuid>

productTypeIdstring<uuid>

[key: string]any

get_products_pagination

Get products with pagination support

get_products_pagination

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_products_pagination",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "where": {
          "enabled": true,
          "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
          "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_products_pagination",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "where": {
      "enabled": true,
      "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
      "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
});

result = await session.call_tool("get_products_pagination", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "enabled": true,
    "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
    "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
  }
})

Request Body

{
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "where": {
    "enabled": true,
    "productCategoryId": "550e8400-e29b-41d4-a716-446655440000",
    "productTypeId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Body

application/json

pagenumber1

Page number

limitnumber10

Items per page

searchstring

Search term

relationsArray<string>

Relations to include

whereobject

Where conditions

Show child attributes

enabledboolean

productCategoryIdstring<uuid>

productTypeIdstring<uuid>

[key: string]any

get_product

Get a specific product by ID

get_product

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_product",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "data": {
          "relations": [
            "string"
          ],
          "findInput": {}
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_product",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "data": {
      "relations": [
        "string"
      ],
      "findInput": {}
    }
  }
});

result = await session.call_tool("get_product", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "relations": [
      "string"
    ],
    "findInput": {}
  }
})

Request Body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "relations": [
      "string"
    ],
    "findInput": {}
  }
}

Body

application/json

idstring<uuid>required

The product ID

dataobject

Query data object

Show child attributes

relationsArray<string>

Relations to include (e.g., ["productType", "productCategory", "tags"])

findInputobject

Additional find input

Show child attributes

[key: string]any

get_product_translated

Get a specific product by ID with translations

get_product_translated

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_product_translated",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "langCode": "string",
        "data": {
          "relations": [
            "string"
          ]
        }
      }
  }
}

const result = await client.callTool({
  "name": "get_product_translated",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "langCode": "string",
    "data": {
      "relations": [
        "string"
      ]
    }
  }
});

result = await session.call_tool("get_product_translated", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "langCode": "string",
  "data": {
    "relations": [
      "string"
    ]
  }
})

Request Body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "langCode": "string",
  "data": {
    "relations": [
      "string"
    ]
  }
}

Body

application/json

idstring<uuid>required

The product ID

langCodestringrequired

Language code for translations

dataobject

Query data object

Show child attributes

relationsArray<string>

Relations to include

create_product

Create a new product in the authenticated user's organization

create_product

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_product",
    "arguments": {
        "product_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "create_product",
  "arguments": {
    "product_data": {}
  }
});

result = await session.call_tool("create_product", arguments={
  "product_data": {}
})

Parameters

product_dataobjectrequired

The data for creating the product. Required fields: code (string), type (object with name), category (object with name)

update_product

Update an existing product

update_product

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_product",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "product_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_product",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "product_data": {}
  }
});

result = await session.call_tool("update_product", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "product_data": {}
})

Parameters

idstring<uuid>required

The product ID

product_dataobjectrequired

The data for updating the product

delete_product

Delete a product

delete_product

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_product",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_product",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_product", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The product ID

add_product_gallery_images

Add images to product gallery

add_product_gallery_images

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_product_gallery_images",
    "arguments": {
        "productId": "550e8400-e29b-41d4-a716-446655440000",
        "images": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z",
            "deletedAt": "2024-01-15T09:30:00Z",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2024-01-15T09:30:00Z",
            "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
            "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
            "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
            "name": "string",
            "url": "https://example.com",
            "width": 0,
            "height": 0,
            "isFeatured": true,
            "thumb": "https://example.com",
            "size": 0,
            "externalProviderId": "string",
            "storageProvider": "string"
          }
        ]
      }
  }
}

const result = await client.callTool({
  "name": "add_product_gallery_images",
  "arguments": {
    "productId": "550e8400-e29b-41d4-a716-446655440000",
    "images": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "deletedAt": "2024-01-15T09:30:00Z",
        "isActive": true,
        "isArchived": false,
        "archivedAt": "2024-01-15T09:30:00Z",
        "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string",
        "url": "https://example.com",
        "width": 0,
        "height": 0,
        "isFeatured": true,
        "thumb": "https://example.com",
        "size": 0,
        "externalProviderId": "string",
        "storageProvider": "string"
      }
    ]
  }
});

result = await session.call_tool("add_product_gallery_images", arguments={
  "productId": "550e8400-e29b-41d4-a716-446655440000",
  "images": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2024-01-15T09:30:00Z",
      "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "url": "https://example.com",
      "width": 0,
      "height": 0,
      "isFeatured": true,
      "thumb": "https://example.com",
      "size": 0,
      "externalProviderId": "string",
      "storageProvider": "string"
    }
  ]
})

Request Body

{
  "productId": "550e8400-e29b-41d4-a716-446655440000",
  "images": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2024-01-15T09:30:00Z",
      "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "url": "https://example.com",
      "width": 0,
      "height": 0,
      "isFeatured": true,
      "thumb": "https://example.com",
      "size": 0,
      "externalProviderId": "string",
      "storageProvider": "string"
    }
  ]
}

Body

application/json

productIdstring<uuid>required

The product ID

imagesArray<object>required

Array of image objects to add to gallery

Show child attributes

idstring<uuid>

createdAtstring<date-time>

updatedAtstring<date-time>

deletedAtstring | null

Show child attributes

Any of

string<date-time>

null

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring | null

Show child attributes

Any of

string<date-time>

null

createdByUserIdstring<uuid>

updatedByUserIdstring<uuid>

deletedByUserIdstring<uuid>

namestringrequired

urlstring

Show child attributes

Any of

string<uri>

string<starts_with>

widthinteger<= 9007199254740991

heightinteger<= 9007199254740991

isFeaturedboolean

thumbstring

Show child attributes

Any of

string<uri>

string<starts_with>

sizeinteger[0, 9007199254740991]

externalProviderIdstring

storageProviderstring

set_product_featured_image

Set an image as featured for a product

set_product_featured_image

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_product_featured_image",
    "arguments": {
        "productId": "550e8400-e29b-41d4-a716-446655440000",
        "image": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "deletedAt": "2024-01-15T09:30:00Z",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2024-01-15T09:30:00Z",
          "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
          "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
          "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
          "name": "string",
          "url": "https://example.com",
          "width": 0,
          "height": 0,
          "isFeatured": true,
          "thumb": "https://example.com",
          "size": 0,
          "externalProviderId": "string",
          "storageProvider": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "set_product_featured_image",
  "arguments": {
    "productId": "550e8400-e29b-41d4-a716-446655440000",
    "image": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2024-01-15T09:30:00Z",
      "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "url": "https://example.com",
      "width": 0,
      "height": 0,
      "isFeatured": true,
      "thumb": "https://example.com",
      "size": 0,
      "externalProviderId": "string",
      "storageProvider": "string"
    }
  }
});

result = await session.call_tool("set_product_featured_image", arguments={
  "productId": "550e8400-e29b-41d4-a716-446655440000",
  "image": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2024-01-15T09:30:00Z",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "string",
    "url": "https://example.com",
    "width": 0,
    "height": 0,
    "isFeatured": true,
    "thumb": "https://example.com",
    "size": 0,
    "externalProviderId": "string",
    "storageProvider": "string"
  }
})

Request Body

{
  "productId": "550e8400-e29b-41d4-a716-446655440000",
  "image": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2024-01-15T09:30:00Z",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "updatedByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "deletedByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "string",
    "url": "https://example.com",
    "width": 0,
    "height": 0,
    "isFeatured": true,
    "thumb": "https://example.com",
    "size": 0,
    "externalProviderId": "string",
    "storageProvider": "string"
  }
}

Body

application/json

productIdstring<uuid>required

The product ID

imageobjectrequired

Image object to set as featured

Show child attributes

idstring<uuid>

createdAtstring<date-time>

updatedAtstring<date-time>

deletedAtstring | null

Show child attributes

Any of

string<date-time>

null

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring | null

Show child attributes

Any of

string<date-time>

null

createdByUserIdstring<uuid>

updatedByUserIdstring<uuid>

deletedByUserIdstring<uuid>

namestringrequired

urlstring

Show child attributes

Any of

string<uri>

string<starts_with>

widthinteger<= 9007199254740991

heightinteger<= 9007199254740991

isFeaturedboolean

thumbstring

Show child attributes

Any of

string<uri>

string<starts_with>

sizeinteger[0, 9007199254740991]

externalProviderIdstring

storageProviderstring

delete_product_gallery_image

Delete an image from product gallery

delete_product_gallery_image

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_product_gallery_image",
    "arguments": {
        "productId": "550e8400-e29b-41d4-a716-446655440000",
        "imageId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_product_gallery_image",
  "arguments": {
    "productId": "550e8400-e29b-41d4-a716-446655440000",
    "imageId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_product_gallery_image", arguments={
  "productId": "550e8400-e29b-41d4-a716-446655440000",
  "imageId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

productIdstring<uuid>required

The product ID

imageIdstring<uuid>required

The image ID to delete

delete_product_featured_image

Delete the featured image of a product

delete_product_featured_image

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_product_featured_image",
    "arguments": {
        "productId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_product_featured_image",
  "arguments": {
    "productId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_product_featured_image", arguments={
  "productId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

productIdstring<uuid>required

The product ID

Stack Overflow Website Demo