API Server
Available Tools
All tools available in the API MCP server
The API server exposes tools for the core operational areas of your Avvyr account. Each tool maps to one API endpoint and is validated against the full schema.
Available tools
| Category | Read-only | Write | Description |
|---|---|---|---|
| Products | pimGetAllProducts, pimGetProductById, pimGetProductBySku | pimUpsertProduct, pimBatchUpsertProducts, pimUpdateProduct, pimDeleteProduct | Create, read, update, and delete products and variants |
| Attributes | pimGetAttributes, pimGetAttributeById, pimGetAttributeOptions | pimCreateAttribute, pimUpdateAttribute, pimDeleteAttribute, pimSetAttributeOptions | Product attribute definitions and option values |
| Attribute Templates | pimGetAttributeTemplates, pimGetAttributeTemplateById | pimCreateAttributeTemplate, pimUpdateAttributeTemplate, pimDeleteAttributeTemplate | Reusable attribute template configurations |
| Attribute Display Groups | pimGetAttributeDisplayGroups | pimCreateAttributeDisplayGroup | Grouping of attributes for display/layout purposes |
| Categories | pimGetCategories, pimGetCategoryById, pimGetCategoryTree | pimCreateCategory, pimUpdateCategory, pimDeleteCategory | Category tree and product categorisation |
| Orders | listOrders, getOrder, getOrderLines | updateOrderStatus, createShipment, allocateShipment, deallocateShipment | Browse and manage orders and fulfilment |
| Return Orders | listReturnOrders, getReturnOrder | createReturnOrder, updateReturnOrder, deleteReturnOrder | Customer returns |
| Quotes | listQuotes, getQuote | createQuote, updateQuote, deleteQuote | Sales quotes |
| Signatures | listSignTemplates, getSignTemplate, getSignStats, listSignatures, getSignature | createSignTemplate, updateSignTemplate, deleteSignTemplate, createSignature, updateSignature, deleteSignature | Digital signature templates and requests |
| Customers | listCustomers, getCustomer | createCustomer, updateCustomer | Manage customer records |
| Inventory | getInventory, listInventory | adjustInventory | Query and adjust stock levels |
| Campaigns | listCampaigns, getCampaign | createCampaign, updateCampaign | Marketing campaigns |
| Discount Codes | listDiscountCodes, getDiscountCode | createDiscountCode, deleteDiscountCode | Vouchers and promotions |
| Prices | listPrices, getPrice | setPrice, updatePrice | Product and variant pricing |
| Gift Cards | listGiftCards, getGiftCard | createGiftCard, updateGiftCard | Gift card management |
| Store Credits | listStoreCredits, getStoreCredit | addStoreCredit, adjustStoreCredit | Customer store credit balances |
| Reviews | listReviews, getReview | approveReview, deleteReview | Customer reviews |
| Automation | listRules, getRule | createRule, updateRule | Automation rules and triggers |
| Warehouses | listWarehouses, getWarehouse | createWarehouse, updateWarehouse | Warehouse locations |
| Shipping | listShippingMethods, getShippingMethod | createShippingMethod, updateShippingMethod | Shipping methods and rates |
| Markets | listMarkets, getMarket | updateMarket | Market and locale settings |
| Assets | listAssets, getAsset | uploadAsset, deleteAsset | Images and file assets |
Tool annotations
| Operation type | Annotation | Meaning |
|---|---|---|
| GET | readOnlyHint: true | Safe to call without side effects |
| POST / PUT / PATCH | readOnlyHint: false | Creates or modifies data |
| DELETE | destructiveHint: true | Client should prompt for confirmation |
Example prompts
"List all draft products in my account"
"Show me all orders from the last 7 days"
"Create a 20% discount code valid until the end of the month"
"What is the current stock level for SKU ABC-123?"
Write operations (POST, PUT, PATCH, DELETE) make real changes to your live data. Use
?read-only=true or a test environment API key during development.