Overview of available API endpoints
- API basics — Fundamentals for using the REST API: authentication, permissions, query parameters.
- API reference authentication — Login via API key or user account, access tokens, token handling.
- API reference inquiries — Management and processing of incoming customer inquiries.
- API reference user management — Management of user accounts and permissions in the admin interface.
- API reference orders — Retrieving, updating, and deleting order data.
- API reference image converter — Management of product and category images as well as other shop graphics.
- API reference blacklist — Maintenance of an exclusion list for email addresses.
- API reference CMS — Retrieval of the URL to the connected content management system (Strapi).
- API reference data feeds — Creation and management of product data feeds for external platforms.
- API reference vouchers — Management of vouchers and voucher templates.
- API reference import — Control and monitoring of data import processes.
- API reference categories — Creating, retrieving, and assigning categories.
- API reference key-value store — Management of entries in the Redis-based key-value store.
- API reference configuration — Access to global and subshop-specific shop settings.
- API reference customer data — The customerAccounts/ endpoint provides a REST interface for managing customer data in the shop system. The API enables creating, retrieving, updating, and deleting customer accounts, addresses, and bank details. Additionally, data can be exported or password resets initiated. All endpoints are designed to enable systematic management and maintenance of customer data beyond the admin interface.
- API reference Log Manager — Retrieving and filtering system logs by timestamp, subshop, or severity level.
- API reference metadata — Management of meta titles and descriptions for pages, products, and categories.
- API reference newsletter — Maintenance of subscriber lists and target groups.
- API reference PayPal onboarding — Management of PayPal onboarding processes.
- API reference products — Creating, retrieving, updating, and deleting products and stock levels.
- API reference product reviews — Retrieving, editing, and deleting product reviews.
- API reference reporter — Export of data records for specific shop areas (e.g. orders, subscribers).
- API reference SEO URLs — Management and generation of search engine friendly URLs.
- API reference sitemaps — Management and generation of XML sitemaps.
- API reference statistics — Retrieval of statistical analyses on shop data (e.g. sales, inquiries).
- API reference stores — Management of stores (markets) in the shop system.
- API reference Stripe onboarding — Management of Stripe onboarding processes.
- API reference template compilation — Triggering and monitoring compilation processes for templates.
- API reference text blocks — Management of language-dependent texts for template output.
- API reference transactions — Retrieving and managing payment information.
- API reference videos — Management and linking of video content in the shop system.