canonical: https://jentic.com/apis/beezup.com/beezup # BeezUP Merchant API The BeezUP Merchant API gives multi-channel sellers programmatic access to product catalog imports, marketplace channel configuration, order harvesting across marketplaces, and performance reporting. It covers store management, custom column rules, exclusion filters, and unified order workflows for harvested orders from connected marketplaces such as Amazon, eBay, Cdiscount, and others. The API spans 248 endpoints across catalog import, channel configuration, order management, analytics reporting, and account administration. ## For AI agents Manage multi-channel product catalogs, configure marketplace exports, and harvest orders from connected marketplaces. Supports rule-based optimisation and cross-channel performance reporting. ## Scope Does not handle direct payment processing, shipping label generation, or warehouse stock movements - use for multi-channel catalog, marketplace order harvesting, and channel performance reporting only. ## Capabilities - Import product catalogs and schedule automatic catalog refreshes - Configure category and column mappings between catalogs and marketplace channels - Harvest orders from connected marketplaces and synchronise their status - Apply exclusion filters and value overrides per channel using rule conditions - Generate performance reports by day, channel, category, and product - Manage store sharing and permissions for collaborators ## Use cases ### Multi-Marketplace Order Sync Pull orders from every connected marketplace into a single normalised stream so a back office or fulfilment system can process them uniformly. The BeezUP order endpoints expose harvest triggers, light and full order lists, and per-order status transitions, allowing a merchant to reconcile and ship without logging into each marketplace. Initial integration with order list, harvest, and status update endpoints typically takes 2 to 3 days for a working pipeline. Example prompt: Call POST `/orders/v3/harvest` to fetch new orders, then iterate the response and POST `/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/changeOrderState` to mark each as shipped ### Catalog Import Automation Automate periodic ingestion of a master product feed into BeezUP so downstream channel exports always reflect the latest pricing and stock. The catalog endpoints support manual import triggers, scheduled auto-imports, importation process status tracking, and replication of channel-specific overrides. A typical setup with a daily import cron, status polling, and error handling takes around a day to wire up. Example prompt: POST a new catalog file, then GET the importation process endpoint until status is Done and surface any row-level validation errors ### Channel Performance Reporting Pull analytics breakdowns by day, channel, category, and product to identify which marketplace listings drive revenue and which need price or content adjustments. The reporting endpoints expose aggregated metrics that can drive bid rules, exclusion filters, or stock allocation decisions. Building an internal dashboard against these endpoints is typically a 1 to 2 day effort. Example prompt: Query the channel reporting endpoint for the last 30 days and return the top 10 SKUs by clicks per channel ### AI Agent for E-Commerce Operations An AI agent uses Jentic to discover and call BeezUP endpoints that monitor catalog imports, surface order anomalies, and trigger reharvests when a marketplace lags. The agent searches Jentic for the relevant operation, loads its schema, and executes against BeezUP without browsing the 248-endpoint surface manually. Integration via Jentic takes under an hour because credential storage, schema loading, and execution are handled by the SDK. Example prompt: Search Jentic for 'harvest marketplace orders' and execute the returned BeezUP operation on a customer account, then summarise new orders by marketplace ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/orders/v3/harvest` | Trigger order harvesting across connected marketplaces | | POST | `/orders/v3/list/full` | List orders with full detail and filters | | GET | `/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}` | Retrieve a specific marketplace order | | GET | `/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}/history` | Get the change history for an order | | POST | `/orders/v3/batches/changeOrders` | Apply a batch of order state changes | | GET | `/orders/v3/status` | Check the current order management service status | ## Key resources - **Orders** — Harvest, list, update status, and manage incidents on orders pulled from connected marketplaces - **Catalogs** — Import product feeds, schedule auto-imports, and inspect importation process state - **Channels** — Configure marketplace channels, mappings, custom columns, and exclusion rules - **Stores** — Create and share merchant stores and manage collaborator rights - **Reporting** — Aggregated performance metrics by day, channel, category, and product - **Account** — Manage user account, security, contracts, invoices, and alerts ## Why Jentic - **Setup:** Wiring the BeezUP Merchant API by hand means carrying the Ocp-Apim-Subscription-Key header, learning the catalog and order harvest endpoints, and threading marketplace, account, and order ids through the lookups yourself. Through Jentic you install once, import the BeezUP Merchant API from the API Directory, store the subscription key once, and your agent calls it. - **Permission scoping:** BeezUP puts the account id and order id in the URL path (`/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}`), so a rule can pin your agent to one account: it reads that account's orders and nothing else. You choose the operations it may call, so batch order changes are not included unless you add them. - **Credential handling:** Your BeezUP subscription key is stored once, encrypted, by your own Jentic One instance and injected as the Ocp-Apim-Subscription-Key header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'harvest marketplace orders' or 'list orders', and Jentic returns the matching BeezUP operation with its parameter schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Best Buy API** — Best Buy product catalog data alongside BeezUP's multi-channel listing management - **eBay API** — Direct eBay marketplace integration without the multi-channel abstraction - **Shopify Admin API** — Storefront and order data from Shopify can flow into BeezUP for cross-marketplace export ## FAQ ### What authentication does the BeezUP Merchant API use? The BeezUP Merchant API uses an API key passed in the Ocp-Apim-Subscription-Key request header. Public endpoints under `/v2/public` are unauthenticated, while user endpoints require the token visible at https://go.beezup.com/Account/MyAccount. When called via Jentic, the subscription key is stored encrypted in your Jentic One instance and never enters the agent context. ### Can I harvest orders from multiple marketplaces with one call? Yes. POST `/orders/v3/harvest` triggers harvesting across every marketplace connected to the account, and POST `/orders/v3/list/full` returns the resulting normalised orders. Per-marketplace variants such as `/orders/v3/{marketplaceTechnicalCode}/{accountId}/harvest` let you scope to a single channel when needed. ### What are the rate limits for the BeezUP Merchant API? BeezUP limits the REST API to 100 calls per minute per account. Bulk operations such as batch order state changes via `/orders/v3/batches/changeOrders` should be preferred over per-order loops to stay within the budget. ### How do I import a product catalog through Jentic? Run pip install jentic, then search Jentic for 'import product catalog beezup'. Jentic returns the catalog import operation, the agent loads its input schema, and executes with the feed URL and store identifier. Poll the importation process endpoint until status is Done before triggering channel exports. ### Is the BeezUP Merchant API free to use? Access to the API requires an active BeezUP merchant subscription; the public registration and login endpoints under `/v2/public` are open but the catalog, channel, order, and reporting endpoints require an authenticated account on a paid plan. Pricing tiers are available at https://www.beezup.com/. ### Can I update marketplace order statuses in bulk? Yes. POST `/orders/v3/batches/changeOrders` accepts a batch of state transitions, and POST `/orders/v3/batches/changeOrders/{changeOrderType}` scopes the batch to a specific transition such as marking shipped or cancelled. This is the recommended approach for fulfilment integrations to avoid hitting the 100 calls per minute limit. ### Can I limit what my agent is allowed to do with the BeezUP Merchant API? Yes. Because you self-host Jentic One, your own rules decide which BeezUP operations and credentials your agent may use. Since BeezUP puts the account id and order id in the URL path, such as `/orders/v3/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}`, you can pin the agent to a single account so it only reads that account's orders and nothing else. You also choose the exact operations it may call, so write actions like batch order state changes via `/orders/v3/batches/changeOrders` stay off limits until you explicitly allow them.