Commerce tools
The server offers 269 tools in 31 toolsets. How to connect and how to choose the toolsets is in Webround Commerce MCP.
Presets
A preset is a named pack of toolsets that belong together.
| Preset | Toolsets |
|---|---|
catalog (default) | products, product-variants, options, tags, tagvalues, attributes, collections, filters, conditions, assets, taxzones, shipping-zones, shipping-methods, warehouses |
orders | orders, orderitems, return-requests, subscriptions, store-customers |
marketing | promotions, conditions, feeds, reviews, cart-analytics |
store-settings | stores, checkout-hooks, webhook |
team | collaborators, roles, api-keys, app-customer, app-developer |
Kinds of tool
| Kind | What the client is told |
|---|---|
| Read | Changes nothing (readOnlyHint). |
| Write | Adds or updates, without removing anything that was there. |
| Replace | Overwrites what was there, for example a PATCH that syncs a whole list (destructiveHint). |
| Delete | Removes data (destructiveHint). |
api-keys
4 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_api_keys | Read | GET /api-keys | List API Keys. Returns a paginated list of API keys for the current store. Raw key values are never returned. |
create_api_key | Write | POST /api-keys | Create API Key. Creates a new API key. The raw key is returned only once and cannot be retrieved again. |
update_api_key | Replace | PATCH /api-keys/{id} | Update API Key. Updates name, scopes, active state or expiry. The token itself is immutable. |
delete_api_key | Delete | DELETE /api-keys/{id} | Revoke API Key. Permanently revokes an API key. All requests using this key will immediately fail. |
app-customer
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
app_customer_controller_find_all | Read | GET /app/customer | Browse App Catalog. Returns all published apps available in the marketplace. |
app_customer_controller_find_bookmarks | Read | GET /app/customer/bookmarks | List Bookmarked Apps. Returns all apps bookmarked by the current store. |
app_customer_controller_launch | Read | GET /app/customer/{id}/launch | Get App Launch URL. Returns a signed launch URL for the app. If the bookmark has a secret, the URL includes an HMAC signature and timestamp for the app to verify the request origin. |
app_customer_controller_create_private | Write | POST /app/customer/private | Create Private App. Creates a private draft app and immediately bookmarks it for this store. Does not appear in the public marketplace. |
app_customer_controller_add_bookmark | Write | POST /app/customer/{id}/bookmark | Bookmark App. Adds an app to the store backoffice. Idempotent. |
app_customer_controller_remove_bookmark | Delete | DELETE /app/customer/{id}/bookmark | Remove Bookmark. Removes an app from the store backoffice. |
app-developer
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
app_developer_controller_find_all | Read | GET /app/developer | List My Apps. Returns all apps owned by the authenticated user, regardless of status. |
app_developer_controller_create | Write | POST /app/developer | Create App. Creates a new app in draft status. |
app_developer_controller_find_one | Read | GET /app/developer/{id} | Get My App. Returns a single app owned by the authenticated user. |
app_developer_controller_update | Replace | PUT /app/developer/{id} | Update App. Updates an app. Only allowed when status is draft or rejected. |
app_developer_controller_delete | Delete | DELETE /app/developer/{id} | Delete App. Deletes an app. Not allowed if status is published. |
app_developer_controller_submit | Write | POST /app/developer/{id}/submit | Submit for Review. Transitions the app from draft or rejected to pending, triggering admin review. |
assets
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_assets | Read | GET /assets | List All Assets. Returns a paginated list of all assets for the current store. |
create_asset | Write | POST /assets | Register New Asset. Creates a single asset entry. Use Core APIs for binary upload. |
get_asset | Read | GET /assets/{id} | Get Asset Details. Retrieves metadata for a specific asset using its UUID. |
update_asset | Replace | PATCH /assets/{id} | Update Asset Metadata |
delete_asset | Delete | DELETE /assets/{id} | Delete Asset |
create_many_assets | Write | POST /assets/create-many | Batch Create Assets. Registers multiple assets in one request. Subject to store data limits. |
delete_many_assets | Write | POST /assets/delete-many | Batch Delete Assets |
update_many_assets | Replace | PATCH /assets/update-many | Batch Update Assets. Updates multiple assets at once. |
attributes
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_attributes | Read | GET /attributes | List All Attributes. Retrieves a paginated list of product attributes for the current store. |
create_attribute | Write | POST /attributes | Create Attribute. Creates a new product attribute configuration. |
get_attribute | Read | GET /attributes/{id} | Get Attribute Details. Retrieves full details of a specific attribute, including translations if a language code is provided. |
update_attribute | Replace | PATCH /attributes/{id} | Update Attribute. Updates the settings or metadata of an existing attribute. |
delete_attribute | Delete | DELETE /attributes/{id} | Delete Attribute. Permanently removes an attribute. Caution: This may affect products using this attribute. |
create_many_attributes | Write | POST /attributes/batch | Batch Create Attributes. Creates multiple attributes in a single request. Subject to plan data limits. |
update_many_attributes | Replace | PATCH /attributes/batch | Batch Update Attributes. Updates multiple attribute configurations simultaneously. |
delete_many_attributes | Write | POST /attributes/delete-many | Batch Delete Attributes. Removes a list of attributes by their IDs. |
cart-analytics
1 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_cart_analytics | Read | GET /cart-analytics | Cart Analytics Dashboard. Returns KPIs, cart list, top products, device and country breakdown for the store. |
checkout-hooks
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_checkout_hooks | Read | GET /checkout-hooks | List Checkout Hooks. Returns the checkout hooks of this store in execution order: by position, then by creation date. Hooks without a position come after the ones that have it, ordered by creation date. |
create_checkout_hook_v2 | Write | POST /checkout-hooks | Create Checkout Hook. Creates a checkout hook with one purpose (kind): cart-transform, discount, shipping or validation. Each hook has its own secret, shown one time only. The number of hooks per kind depends on the store plan. |
list_checkout_hook_v2_logs | Read | GET /checkout-hooks/logs | List Checkout Hook Logs. Paginated log of the checkout hook invocations of this store, most recent first. Quote calls are logged only on error; checkout (pay) calls are always logged. |
get_checkout_hook_by_id | Read | GET /checkout-hooks/{id} | Get Checkout Hook. Returns one checkout hook. The secret is never returned. |
update_checkout_hook_v2 | Replace | PATCH /checkout-hooks/{id} | Update Checkout Hook. Updates name, url, timeout, onError, position, active state or app. The kind and the secret cannot be changed. |
delete_checkout_hook_v2 | Delete | DELETE /checkout-hooks/{id} | Delete Checkout Hook. Permanently deletes the hook, its secret and its logs. |
collaborators
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
invite_collaborator | Write | POST /collaborators/invite | Invite Collaborator. Sends an invitation email to a new collaborator. Subject to store data limits. |
accept_invite | Read | GET /collaborators/accept | Accept Invitation. Validates the invitation token and joins the store. |
list_collaborators | Read | GET /collaborators | List Collaborators. Retrieves a paginated list of all collaborators for the current store. |
remove_collaborator | Delete | DELETE /collaborators/{collaboratorId} | Remove Collaborator. Removes a collaborator from a store. |
get_roles | Read | GET /collaborators/{collaboratorId}/roles | Get Collaborator Roles |
assign_roles | Replace | PATCH /collaborators/{collaboratorId}/roles | Update Collaborator Roles. Replaces current roles with the newly provided list. |
collections
10 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_collections | Read | GET /collections | List Collections. Returns a paginated list of categories/collections. Supports filtering by parentId for hierarchical navigation. |
create_collection | Write | POST /collections | Create Collection |
get_collection | Read | GET /collections/{id} | Get Collection Details |
update_collection | Replace | PATCH /collections/{id} | Update Collection |
delete_collection | Delete | DELETE /collections/{id} | Delete Collection |
create_many_collections | Write | POST /collections/create-many | Bulk Create Collections |
delete_many_collections | Write | POST /collections/delete-many | Bulk Delete Collections |
update_many_collections | Replace | PATCH /collections/update-many | Bulk Update Collections |
collection_controller_get_filters | Read | GET /collections/{id}/filters | collection_controller_get_filters |
replace_collection_filters | Replace | PATCH /collections/{id}/filters | Link Filters to Collection |
conditions
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_conditions | Read | GET /conditions | List Conditions. Returns all product conditions defined for the current store. |
create_condition | Write | POST /conditions | Create Condition |
get_condition | Read | GET /conditions/{id} | Get Condition |
update_condition | Replace | PATCH /conditions/{id} | Update Condition |
delete_condition | Delete | DELETE /conditions/{id} | Delete Condition |
create_many_conditions | Write | POST /conditions/batch | Bulk Create Conditions |
update_many_conditions | Replace | PATCH /conditions/batch | Bulk Update Conditions |
delete_many_conditions | Write | POST /conditions/delete-many | Bulk Delete Conditions |
feeds
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_feeds | Read | GET /feeds | List Feeds |
create_feed | Write | POST /feeds | Create Feed |
get_feed | Read | GET /feeds/{id} | Get Feed |
update_feed | Replace | PATCH /feeds/{id} | Update Feed |
delete_feed | Delete | DELETE /feeds/{id} | Delete Feed |
generate_feed | Write | POST /feeds/{id}/generate | Generate Feed. Generates the feed file on-demand and returns it as a downloadable attachment. |
filters
10 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_filters | Read | GET /filters | List Filters. Retrieves all product filters (condition groups) for the store. |
create_filter | Write | POST /filters | Create Filter |
get_filter | Read | GET /filters/{id} | Get Filter Details |
update_filter | Replace | PATCH /filters/{id} | Update Filter |
delete_filter | Delete | DELETE /filters/{id} | Delete Filter |
create_many_filters | Write | POST /filters/batch | Bulk Create Filters |
update_many_filters | Replace | PATCH /filters/batch | Bulk Update Filters |
delete_many_filters | Write | POST /filters/delete-many | Bulk Delete Filters |
get_filter_conditions | Read | GET /filters/{id}/conditions | Get Filter Conditions |
replace_conditions | Replace | PATCH /filters/{id}/conditions | Sync Filter Conditions |
options
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_options | Read | GET /options | List Options. Retrieves a paginated list of all product options available in the store. |
create_option | Write | POST /options | Create Option |
get_option | Read | GET /options/{id} | Get Option Details |
update_option | Replace | PATCH /options/{id} | Update Option |
delete_option | Delete | DELETE /options/{id} | Delete Option |
batch_create_options | Write | POST /options/create-many | Bulk Create Options |
batch_delete_options | Write | POST /options/delete-many | Bulk Delete Options |
batch_update_options | Replace | PATCH /options/update-many | Bulk Update Options |
orderitems
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
create_many_order_items | Write | POST /order-items/batch | Bulk Add Items. Adds multiple product items to an order in a single request. |
update_many_order_items | Replace | PATCH /order-items/batch | Bulk Update Items. Updates multiple order items within the same store context. |
delete_many_order_items | Write | POST /order-items/delete-many | Bulk Remove Items. Removes a batch of items from their respective orders using UUIDs. |
create_order_item | Write | POST /order-items | Add Item to Order. Adds a specific product variant to an order with quantity and unit price. |
update_order_item | Replace | PATCH /order-items/{id} | Update Item. Modifies an existing order item details like quantity or discount. |
delete_order_item | Delete | DELETE /order-items/{id} | Remove Order Item. Permanently removes a specific item from its associated order. |
orders
15 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_orders | Read | GET /orders | List All Orders. Returns a paginated list of all orders for the current store. |
create_order | Write | POST /orders | Create Manual Order. Allows administrators to manually create a new order in the system. |
export_orders | Write | POST /orders/export | Export Orders. Returns orders with their items as HTML for printing. Same filters as list, max 100 results. |
create_checkout_link | Write | POST /orders/{id}/checkout-link | Create Checkout Link. Returns a Stripe Checkout URL for the specific order. |
get_order | Read | GET /orders/{id} | Get Order Details. Retrieves detailed information for a specific order by UUID. |
update_order | Replace | PATCH /orders/{id} | Update Order. Updates metadata, status, or shipping information for an existing order. |
delete_order | Delete | DELETE /orders/{id} | Delete Order. Permanently removes an order from the store database. |
get_orders_by_customer | Read | GET /orders/by-customer/{customerId} | List Customer Orders. Retrieves all orders associated with a specific customer ID. |
create_order_from_cart | Write | POST /orders/from-cart | Create Manual Order From Cart. Allows administrators to manually create a new order in the system through a cart. |
create_many_orders | Write | POST /orders/create-many | Bulk Create Orders. Creates multiple orders in a single batch operation. |
delete_many_orders | Write | POST /orders/delete-many | Bulk Delete Orders. Deletes a list of orders by their UUIDs in a single request. |
update_many_orders | Replace | PATCH /orders/update-many | Bulk Update Orders. Updates multiple orders simultaneously (e.g., mass status change). |
get_items | Read | GET /orders/{orderId}/items | Get Order Items. Retrieves all products and quantities associated with a specific order. |
get_order_promotion_usages | Read | GET /orders/{orderId}/promotion-usages | Get Order Promotion Usages. Returns the promotion usages recorded for a specific order. |
sync_order_promotion_usages | Replace | PATCH /orders/{orderId}/promotion-usages | Sync Order Promotion Usages. Records that one or more promotions were used on a specific order. |
product-variants
28 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_product_variants | Read | GET /product-variants | List Variants. Retrieves a paginated list of all product variants in the store. |
create_product_variant | Write | POST /product-variants | Create Variant. Creates a new product variant. |
get_product_variant | Read | GET /product-variants/{id} | Get Variant Details. Retrieves full details for a variant, including inherited translations. |
update_product_variant | Replace | PATCH /product-variants/{id} | Update Variant. Updates specific variant metadata. |
delete_product_variant | Delete | DELETE /product-variants/{id} | Delete Variant. Removes a variant and its local overrides. |
batch_create_variants | Write | POST /product-variants/create-many | Bulk Create Variants. Creates multiple variants in a single request. |
batch_delete_variants | Write | POST /product-variants/delete-many | Bulk Delete Variants. Removes a list of variants. |
batch_update_variants | Replace | PATCH /product-variants/update-many | Bulk Update Variants. Updates multiple variants in one operation. |
get_variant_assets | Read | GET /product-variants/{id}/assets | Get Variant Assets. Retrieves assets for this variant, including inherited ones from master product. |
replace_variant_assets | Replace | PATCH /product-variants/{id}/assets | Sync Variant Assets. Replaces variant-level assets. |
get_variant_tags | Read | GET /product-variants/{id}/tag-values | Get Variant Tags. Retrieves tags for this variant with inheritance support. |
replace_variant_tag_values | Replace | PATCH /product-variants/{id}/tag-values | Sync Variant Tags. Replaces variant-level tags. |
get_variant_attributes | Read | GET /product-variants/{id}/attributes | Get Variant Attributes. Retrieves custom attributes with inheritance support. |
replace_variant_attribute_values | Replace | PATCH /product-variants/{id}/attributes | Sync Variant Attributes. Replaces variant-level attributes. |
get_variant_shipping_methods | Read | GET /product-variants/{id}/shipping-methods | Get Variant Shipping Methods. Retrieves specific shipping overrides. |
replace_variant_shipping_methods | Replace | PATCH /product-variants/{id}/shipping-methods | Sync Variant Shipping Methods. Replaces variant-level shipping methods. |
get_variant_shipping_zones | Read | GET /product-variants/{id}/shipping-zones | Get Variant Shipping Zones. Retrieves specific shipping zone overrides. |
replace_variant_shipping_zones | Replace | PATCH /product-variants/{id}/shipping-zones | Sync Variant Shipping Zones. Replaces variant-level shipping zones. |
get_variant_tax_zones | Read | GET /product-variants/{id}/tax-zones | Get Variant Tax Zones. Retrieves specific tax zone overrides. |
replace_variant_tax_zones | Replace | PATCH /product-variants/{id}/tax-zones | Sync Variant Tax Zones. Replaces variant-level tax zones. |
get_variant_promotion_exclusions | Read | GET /product-variants/{id}/promotion-exclusions | Get Promotion Exclusions. Lists promotions disabled for this variant. |
replace_variant_promotion_exclusions | Replace | PATCH /product-variants/{id}/promotion-exclusions | Sync Promotion Exclusions. Replaces active promotion exclusions. |
get_variant_option_values | Read | GET /product-variants/{id}/option-values | Get Option Values. Lists the option values that identify this variant. |
replace_variant_option_values | Replace | PATCH /product-variants/{id}/option-values | Sync Option Values. Replaces the set of option values used to identify the variant. |
get_variant_linked_prices | Read | GET /product-variants/{id}/prices | Get Linked Prices. Lists all prices tied to the variant. |
replace_variant_prices | Replace | PATCH /product-variants/{id}/prices | Sync Prices. Replaces the set of prices for this variant. |
get_variant_stock | Read | GET /product-variants/{id}/stock | Get Stock. Lists all the variant stock quantities. |
quick_update_variant_stock | Replace | PATCH /product-variants/{id}/stock/quick | Quick Update Stock. Overwrites stock on the default warehouse (or oldest) without requiring a warehouse ID. |
products
26 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_products | Read | GET /products | List All Products. Retrieves a paginated and searchable list of all products for the current store. |
create_product | Write | POST /products | Create Product. Initializes a new product with basic metadata and configuration. |
get_product | Read | GET /products/{id} | Get Product Details. Retrieves detailed information for a single product including its translations. |
update_product | Replace | PATCH /products/{id} | Update Product. Updates core product information for a specific UUID. |
delete_product | Delete | DELETE /products/{id} | Delete Product. Permanently removes a product and all its local relations. |
get_product_variants | Read | GET /products/{id}/variants | List Product Variants. Returns a paginated list of all variants associated with a specific product. |
generate_variants | Write | POST /products/{id}/variants | Generate Missing Variants. Automatically creates variant Variants based on product option combinations. |
create_many_products | Write | POST /products/create-many | Bulk Create Products. Creates multiple products in a single batch operation. |
delete_many_products | Write | POST /products/delete-many | Bulk Delete Products. Removes a list of products by their UUIDs in batch. |
duplicate_product | Write | POST /products/{id}/duplicate | Duplicate Product. Creates a full copy of an existing product and its configurations. |
update_many_products | Replace | PATCH /products/update-many | Bulk Update Products. Updates multiple products simultaneously. |
get_assets | Read | GET /products/{id}/assets | Get Product Assets. Retrieves all images, videos, and documents linked to the product. |
replace_assets | Replace | PATCH /products/{id}/assets | Sync Product Assets. Replaces all assets associated with the product. |
get_tag_values | Read | GET /products/{id}/tag-values | Get Product Tags. Returns all tag values currently assigned to the product. |
replace_tag_values | Replace | PATCH /products/{id}/tag-values | Sync Product Tags. Replaces all tag value associations. |
get_option_values | Read | GET /products/{id}/option-values | Get Product Options. Lists all variant option values (size, color, etc.) associated with the product. |
replace_option_values | Replace | PATCH /products/{id}/option-values | Sync Options. Replaces product variant option associations. |
get_attribute_values | Read | GET /products/{id}/attributes | Get Product Attributes. Retrieves all custom attributes and specifications for the product. |
replace_attribute_values | Replace | PATCH /products/{id}/attributes | Sync Product Attributes. Replaces all product custom attributes. |
get_shipping_methods | Read | GET /products/{id}/shipping-methods | Get Product Shipping Methods. Returns the allowed shipping methods for this specific product. |
replace_shipping_methods | Replace | PATCH /products/{id}/shipping-methods | Sync Product Shipping Methods. Updates allowed shipping methods for this product. |
get_shipping_zones | Read | GET /products/{id}/shipping-zones | Get Product Shipping Zones. Lists all geographical zones where this product can be shipped. |
replace_shipping_zones | Replace | PATCH /products/{id}/shipping-zones | Sync Product Shipping Zones. Updates regional shipping availability. |
get_tax_zones | Read | GET /products/{id}/tax-zones | Get Product Tax Zones. Retrieves tax configuration zones applied to the product. |
replace_tax_zones | Replace | PATCH /products/{id}/tax-zones | Sync Product Tax Zones. Updates tax configuration zones. |
create_product_aggregate | Write | POST /products/aggregate | Create Product Aggregate. Creates a product with all its relations (assets, tags, attributes, options, shipping, tax) and variants (with prices, stock, and their own relations) in a single atomic operation. If any part fails, the entire operation is rolled back. |
promotions
12 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_promotions | Read | GET /promotions | List Promotions. Retrieves all active and inactive promotions for the store. |
create_promotion | Write | POST /promotions | Create Promotion. Initializes a new promotion with its rules and reward types. |
get_promotion_by_id | Read | GET /promotions/{id} | Get Promotion. Returns details of a specific promotion including its current status. |
update_promotion | Replace | PATCH /promotions/{id} | Update Promotion. Modifies an existing promotion configuration. |
delete_promotion | Delete | DELETE /promotions/{id} | Delete Promotion. Permanently removes a promotion from the system. |
create_many_promotions | Write | POST /promotions/create-many | Bulk Create Promotions. Enables batch creation of promotional campaigns. |
update_many_promotions | Replace | PATCH /promotions/update-many | Bulk Update Promotions. Updates multiple promotions in a single request. |
delete_many_promotions | Write | POST /promotions/delete-many | Bulk Delete Promotions. Removes a list of promotions by ID. |
get_promotion_filters | Read | GET /promotions/{id}/filters | Get Filters. Returns all filter IDs associated with this promotion (Targeting rules). |
replace_promotion_filters | Replace | PATCH /promotions/{id}/filters | Sync Filters. Synchronizes the target rules (filters) for the promotion. |
apply_promotion | Write | POST /promotions/{id}/apply | Apply Promotion. Triggers the calculation/application logic for the promotion. If you linked some filters, they will be used to change your catalog according to the promotion discount. |
reset_promotion | Write | POST /promotions/{id}/reset | Reset Promotion. Reverts the catalog data to restore the initial state present before the promotion. |
return-requests
5 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
list_return_requests_admin | Read | GET /return-requests | List Return Requests (Admin). Paginated list of return requests for the current store. |
create_return_request_admin | Write | POST /return-requests | Create Return Request (Admin). Creates a return request on behalf of a customer. |
get_return_request_admin | Read | GET /return-requests/{id} | Get Return Request (Admin). Retrieves a single return request by ID. |
update_return_request_admin | Replace | PATCH /return-requests/{id} | Update Return Request (Admin). Updates status, items, reason or merchant note. |
delete_return_request_admin | Delete | DELETE /return-requests/{id} | Delete Return Request (Admin). Permanently removes a return request. |
reviews
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_customer_reviews | Read | GET /reviews/by-customer | Get My Reviews. Retrieves all reviews written by the authenticated customer. |
get_variant_reviews | Read | GET /reviews/product-variants/{id} | Get Variant Reviews. Retrieves paginated public reviews for a specific product variant. |
create_review | Write | POST /reviews/product-variants/{id} | Create Review. Submits a new review for a product variant. One review per customer per variant. |
update_review | Replace | PATCH /reviews/{id} | Update Review. Updates an existing review owned by the authenticated customer. |
delete_review | Delete | DELETE /reviews/{id} | Delete Review. Permanently removes a review owned by the authenticated customer. |
list_store_reviews | Read | GET /product-reviews | List Store Reviews. Returns the reviews of this store, a page at a time, with the customer's name and the variant each one is about. Filter by grade, product, variant, customer and verified purchase, and look for a customer by name, email or phone (searchText, as in the store's customers). Newest first unless said otherwise. |
get_store_review_by_id | Read | GET /product-reviews/{id} | Get Store Review. Returns one review of this store. |
delete_store_review | Delete | DELETE /product-reviews/{id} | Delete Store Review. Moderation: permanently removes any review of this store, whoever wrote it. The product's grade is worked out again. |
roles
7 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_store_roles | Read | GET /roles | List Roles. Retrieves a paginated list of all roles defined within the store context. |
create_role | Write | POST /roles | Create Role. Creates a new custom role for the store. |
get_role_by_id | Read | GET /roles/{roleId} | Get Role. Returns details of a specific role. |
update_role | Replace | PATCH /roles/{roleId} | Update Role. Updates an existing role metadata. |
delete_role | Delete | DELETE /roles/{roleId} | Delete Role. Removes a role. Warning: check for assigned users before deletion. |
get_role_permissions | Read | GET /roles/{roleId}/permissions | Get Role Permissions. Retrieves the list of permissions currently granted to this role. |
replace_role_permissions | Replace | PATCH /roles/{roleId}/permissions | Sync Role Permissions. Replaces the entire set of permissions for a role. |
shipping-methods
5 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_shipping_methods_get | Read | GET /shipping-methods | List Shipping Methods. Retrieves a paginated list of all shipping methods configured for the store. |
create_shipping_method | Write | POST /shipping-methods | Create Shipping Method. Creates a new shipping option for the customers. |
get_shipping_method_by_id | Read | GET /shipping-methods/{id} | Get Shipping Method. Returns details of a specific shipping method, supporting localized content. |
update_shipping_method | Replace | PATCH /shipping-methods/{id} | Update Shipping Method. Modifies an existing shipping method configuration. |
delete_shipping_method | Delete | DELETE /shipping-methods/{id} | Delete Shipping Method. Removes a shipping method from the store. Note: This might affect existing orders or zone configurations. |
shipping-zones
5 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_shipping_zones_get | Read | GET /shipping-zones | List Shipping Zones. Retrieves a paginated list of all geographical shipping zones defined in the store. |
create_shipping_zone | Write | POST /shipping-zones | Create Shipping Zone. Registers a new shipping zone for the store. |
get_shipping_zone_by_id | Read | GET /shipping-zones/{id} | Get Shipping Zone. Returns the configuration of a specific shipping zone. |
update_shipping_zone | Replace | PATCH /shipping-zones/{id} | Update Shipping Zone. Modifies the settings of an existing shipping zone. |
delete_shipping_zone | Delete | DELETE /shipping-zones/{id} | Delete Shipping Zone. Deletes a shipping zone. Caution: methods linked to this zone might become unreachable. |
store-customers
13 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_store_customers | Read | GET /store-customers | List Customers. Retrieves a filtered, paginated list of customers. |
create_store_customer | Write | POST /store-customers | Create Customer. Manually creates a new customer profile. |
get_customer_by_id | Read | GET /store-customers/{id} | Get Customer. Returns full profile of a customer. |
update_store_customer | Replace | PATCH /store-customers/{id} | Update Customer. Updates specific customer profile data. |
delete_store_customer | Delete | DELETE /store-customers/{id} | Delete Customer. Deletes a customer profile and associated local data. |
customer_reset_password | Write | POST /store-customers/{id}/reset-password | Send Reset Password. Sends a password recovery email to the customer. |
customer_verify_email | Write | POST /store-customers/{id}/verify-email | Send Verification Email. Sends an email verification link to the customer. |
batch_create_customers | Write | POST /store-customers/create-many | Bulk Create Customers |
batch_delete_customers | Write | POST /store-customers/delete-many | Bulk Delete Customers |
batch_update_customers | Replace | PATCH /store-customers/update-many | Bulk Update Customers |
merge_guest_duplicates | Write | POST /store-customers/{id}/merge | Merge Guest Duplicates. Merges all guest customer records with the same email into the target customer. Orders, addresses and lifetime value are transferred. Guest records are deleted. |
get_customer_promotions | Read | GET /store-customers/{id}/promotions | Get Customer Promotions. Lists all promotions specifically assigned to this customer. |
replace_customer_promotions | Replace | PATCH /store-customers/{id}/promotions | Sync Customer Promotions. Synchronizes the list of assigned promotions for the customer. |
stores
10 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
get_store_dashboard_data | Read | GET /stores/dashboard | Get Store Dashboard Data. Retrieves key metrics for the store. Defaults to the last 7 days if dates are not provided. |
get_store_sitemap | Read | GET /stores/sitemap | Download Store Sitemap. Generates and downloads a ZIP file containing the Google-compliant sitemaps for the store products. Requires a paid plan. |
list_owner_stores | Read | GET /stores/owner/{ownerId} | List Stores By Owner. Retrieves all stores associated with a specific owner UUID. While regular users are restricted to their own ID, administrative roles (Admin, Dev, Agent) can use this to audit any user's stores. |
update_store | Replace | PATCH /stores/{id} | Update Store Configuration. Updates the metadata and settings of an active store. This operation is guarded by StoreActiveGuard; inactive or suspended stores cannot be modified. |
delete_store | Delete | DELETE /stores/{id} | Delete Store. Marks the store for logical deletion. The store is immediately hidden from public view, but data is retained for a grace period to allow for potential restoration. |
restore_store | Write | POST /stores/{id}/restore | Restore Deleted Store. Reverses a previous deletion request, bringing the store back to an active and visible state. This is only possible if the data has not been permanently purged. |
store_controller_create_store | Write | POST /stores/{id} | Create Store. Create a Webround Commerce Store starting from a draft. |
store_controller_delete_images | Replace | POST /stores/{id}/images/delete | Delete Store Images. Bulk delete images by asset IDs. |
store_controller_create_video_upload | Write | POST /stores/{id}/videos | Request Video Upload. Generates a signed URL to upload a video file directly to Bunny.net. |
store_controller_delete_video | Delete | DELETE /stores/{id}/videos/{assetId} | Delete Store Video. Permanently deletes a video asset from the store and Bunny.net storage, then synchronizes the used storage space. |
subscriptions
3 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
subscription_controller_find_all | Read | GET /subscriptions | Get all subscriptions. Returns a paginated list of all subscriptions for the current store. |
subscription_controller_find_one | Read | GET /subscriptions/{id} | Get single subscription. Retrieves specific subscription details using its UUID. |
subscription_controller_find_all_by_customer | Read | GET /subscriptions/by-customer/{customerId} | Get customer subscriptions. Retrieves all subscriptions associated with a specific customer ID. |
tags
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
tag_controller_find_all | Read | GET /tags | Get all tags. Retrieves a paginated list of tags for the store. |
tag_controller_create | Write | POST /tags | Create tag. Creates a new tag for products. |
tag_controller_find_one | Read | GET /tags/{id} | Get single tag. Retrieves a tag by ID with optional language translation. |
tag_controller_update | Replace | PATCH /tags/{id} | Update tag. Updates an existing tag by ID. |
tag_controller_delete | Delete | DELETE /tags/{id} | Delete tag. Permanently removes a tag by ID. |
tag_controller_create_many | Write | POST /tags/batch | Batch create tags. Creates multiple tags in a single request. |
tag_controller_update_many | Replace | PATCH /tags/batch | Batch update tags. Updates multiple tags in a single request. |
tag_controller_delete_many | Write | POST /tags/delete-many | Batch delete tags. Deletes multiple tags by their IDs. |
tagvalues
10 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
tag_value_controller_find_all | Read | GET /tag-values | Get all tag values. Retrieves a paginated list of all tag values for the store. |
tag_value_controller_create | Write | POST /tag-values | Create tag value. Adds a new value entry to a tag. |
tag_value_controller_find_one | Read | GET /tag-values/{id} | Get single tag value. Retrieves a specific tag value by ID with optional translation. |
tag_value_controller_update | Replace | PATCH /tag-values/{id} | Update tag value. Updates an existing tag value record. |
tag_value_controller_delete | Delete | DELETE /tag-values/{id} | Delete tag value. Permanently removes a tag value. |
tag_value_controller_find_by_tag_id | Read | GET /tag-values/by-tag/{tagId} | Get values by tag ID. Retrieves a paginated list of values belonging to a specific tag. |
tag_value_controller_create_many | Write | POST /tag-values/batch | Batch create tag values. Creates multiple tag values in one operation. |
tag_value_controller_update_many | Replace | PATCH /tag-values/batch | Batch update tag values. Updates multiple tag values at once. |
tag_value_controller_delete_many | Write | POST /tag-values/delete-many | Batch delete tag values. Removes multiple tag values by ID. |
tag_value_controller_generate_filter | Write | POST /tag-values/{id}/generate-filter | Generate filter from tag value. Creates a condition and a filter linked to the specified tag value in a single atomic operation. |
taxzones
8 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
tax_zone_controller_find_all | Read | GET /tax-zones | Get all tax zones. Retrieves a paginated list of tax zones for the current store. |
tax_zone_controller_create | Write | POST /tax-zones | Create tax zone. Creates a new tax zone entry. |
tax_zone_controller_find_one | Read | GET /tax-zones/{id} | Get single tax zone. Retrieves specific details for a tax zone using its ID. |
tax_zone_controller_update | Replace | PATCH /tax-zones/{id} | Update tax zone. Updates an existing tax zone record. |
tax_zone_controller_delete | Delete | DELETE /tax-zones/{id} | Delete tax zone. Permanently removes a tax zone. |
tax_zone_controller_create_many | Write | POST /tax-zones/batch | Batch create tax zones. Creates multiple tax zones in a single request. |
tax_zone_controller_update_many | Replace | PATCH /tax-zones/batch | Batch update tax zones. Updates multiple tax zones in bulk. |
tax_zone_controller_delete_many | Write | POST /tax-zones/delete-many | Batch delete tax zones. Removes multiple tax zones by ID list. |
warehouses
7 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
warehouse_controller_get_warehouses | Read | GET /warehouses | List all warehouses. Retrieves a paginated list of all warehouses associated with the store. |
warehouse_controller_create | Write | POST /warehouses | Create warehouse. Adds a new physical or virtual warehouse to the store. |
warehouse_controller_find_one | Read | GET /warehouses/{id} | Get warehouse details. Finds a specific warehouse by ID. |
warehouse_controller_update | Replace | PATCH /warehouses/{id} | Update warehouse. Updates warehouse configuration and metadata. |
warehouse_controller_delete | Delete | DELETE /warehouses/{id} | Delete warehouse. Removes a warehouse entry from the store. |
warehouse_controller_update_variant_stock | Replace | PATCH /warehouses/stock | Update Variant Stock. Updates the inventory count for a specific varinat in a warehouse. |
warehouse_controller_get_variants_in_warehouse | Read | GET /warehouses/{id}/stock | List Variants in warehouse. Retrieves all product Variants and their stock levels for a specific warehouse. |
webhook
6 tools.
| Tool | Kind | Endpoint | What it does |
|---|---|---|---|
webhook_controller_get_webhooks | Read | GET /webhooks | Get all webhooks. Returns the list of all configured webhooks for the store. |
webhook_controller_create | Write | POST /webhooks | Create webhook. Registers a new webhook endpoint to listen for store events. |
webhook_controller_get_webhook_events | Read | GET /webhooks/events | Get webhook events. Retrieves a paginated list of all webhook events and delivery attempts. |
webhook_controller_replay_event | Write | POST /webhooks/events/{id}/replay | Replay webhook event. Manually triggers a retry for a specific webhook event delivery. |
webhook_controller_update | Replace | PATCH /webhooks/{id} | Update webhook. Updates an existing webhook configuration (URL, events, active status). |
webhook_controller_delete | Delete | DELETE /webhooks/{id} | Delete webhook. Permanently removes a webhook configuration. |