Shopware Store API
This endpoint reference contains an overview of all endpoints comprising the Shopware Store API
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This endpoint reference contains an overview of all endpoints comprising the Shopware Store API
Endpoints 260
Experimental
- GETFetch a breadcrumb
/breadcrumb/:idPerform search to get category or product breadcrumb. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking… - GETFetch all cookie groups
/cookie-groupsFetch all cookie groups available in the system with configuration hash. Experimental API, not part of our backwards compatibility promise, thus this API can… - GETFetch resolved snippets
/snippetReturns the fully resolved snippets (translations) for the authenticated sales channel as a flat key-value map. The language is taken from the sw-language-id…
Store API
- POSTAdd customized product to cart
/customized-products/add-to-cartAdds a customized product to the cart. - POSTCreate configuration share link
/customized-products/configuration/create-shareCreates a share link for a customized product configuration. - POSTReorder customized products
/customized-products/reorder/:orderIdReorders an order with support for customized products. - POSTUpload customized product file
/customized-products/uploadUploads a file for a customized product option. - POSTLoads customized product templates by criteria.
/swag_customized_products_template - POSTLoads customized product template configurations by criteria.
/swag_customized_products_template_configuration - POSTLoads customized product template options by criteria.
/swag_customized_products_template_option - POSTLoads customized product template option values by criteria.
/swag_customized_products_template_option_value - POSTcreatePayPalExpressOrder
/paypal/express/create-orderCreates a PayPal order from the existing cart - POSTpreparePayPalExpressCheckout
/paypal/express/prepare-checkoutLogs in a guest customer, with the data of a paypal order - POSThandlePayPalExpressShippingCallback
/paypal/express/shipping-callback/:salesChannelId/:tokenHandles PayPal shipping address change callbacks and returns updated cart pricing - GETgetPUIPaymentInstructions
/paypal/pui/payment-instructions/:transactionIdTries to get payment instructions for PUI payments - POSTpaypalVaultClear
/paypal/vault/clearClears the vault for the current customer - POSTcreatePayPalOrder
/paypal/create-orderCreates a PayPal order from the existing cart or an order - GETgetPayPalCustomerVaultToken
/paypal/vault-tokenTries to get the customer vault token - POSTsetPaymentMethodEligibility
/paypal/payment-method-eligibilitySets ineligible payment methods to be removed from the current sales channel context
Natural language search
- POSTFetch search terms by natural language search query
/product/natural-language/search-termFetch search terms by natural search language query
Search by Image
- POSTFetch product search terms by uploading an image.
/product/image-upload-search/search-termFetch product search terms by uploading an image.
Advanced Product Catalogs
- GETList advanced product catalog categories
/advanced-product-catalogs/categoriesRetrieve a list of categories for advanced product catalogs with hierarchical sorting - POSTList advanced product catalog categories (POST)
/advanced-product-catalogs/categoriesRetrieve a list of categories for advanced product catalogs with hierarchical sorting using POST method - GETSearch advanced product catalog categories
/advanced-product-catalogs/categories/searchSearch for categories in advanced product catalogs using criteria - POSTCreate or update advanced product catalog
/advanced-product-catalogs/saveCreate a new advanced product catalog or update an existing one - PATCHUpdate advanced product catalog
/advanced-product-catalogs/saveUpdate an existing advanced product catalog - DELETERemove categories from advanced product catalog
/advanced-product-catalogs/categories/removeRemove specific categories from an advanced product catalog
B2B Budget Management
- GETLoad budgets
/budgetsThis route is used to load all budgets for the current customer - POSTLoad budgets
/budgetsThis route is used to load all budgets for the current customer - GETLoad single budget
/budget/:idThis route is used to load one budget by ID Available Associations: customer organizations notificationRecipients reviewerRole currency subscriptionBudgets - POSTLoad single budget
/budget/:idThis route is used to load one budget by ID Available Associations: customer organizations notificationRecipients reviewerRole currency subscriptionBudgets - PATCHUpdate budget
/budget/:idThis route is used to update an existing budget - POSTCreate new budget
/budgetThis route is used to create a new budget - DELETEDelete budgets
/budgets/deleteThis route is used to delete multiple budgets - POSTStore budget recipients
/budget/:id/recipientsThis route is used to add recipients (employees) to a budget for notifications - DELETEDelete budget recipients
/budget/:id/recipientsThis route is used to remove recipients (employees) from a budget - GETGet available budgets for checkout
/checkout/budgetsThis route is used to get available budgets for the current employee during checkout - POSTGet available budgets for checkout
/checkout/budgetsThis route is used to get available budgets for the current employee during checkout - GETGet budget statistics for checkout
/checkout/budget/:budgetId/statisticThis route is used to get budget statistics for the current employee during checkout - POSTGet budget statistics for checkout
/checkout/budget/:budgetId/statisticThis route is used to get budget statistics for the current employee during checkout
B2B Employee Management
- POSTCreate a single employee and return the employee
/employee/createThis route is used to create and return an employee - GETFetch a list of employees
/employeeThis route is used to load employees - POSTFetch a list of employees
/employeeThis route is used to load employees - GETFetch one employee by id
/employee/:idThis route is used to fetch one employee by id Available Associations: account role language organization - DELETEDelete one employee by id
/employee/:idThis route is used to delete one employee by id - PATCHUpdate one employee by id
/employee/:idThis route is used to update one employee by id - POSTReinvite employee by id
/employee/reinvite/:idThis route is used to reinvite an employee via email by id - GETFetch all available permissions
/permissionThis route is used to fetch all available permissions - POSTAdd a new permission
/permissionThis route is used to add a new permissions - POSTCreate a single role and return the role
/role/createThis route is used to create and return an role - GETFetch a list of roles
/roleThis route is used to load roles - POSTFetch a list of roles
/roleThis route is used to load roles - GETFetch one role by id
/role/:idThis route is used to fetch one role by id - DELETEDelete one role by id
/role/:idThis route is used to delete one role by id - PATCHUpdate one role by id
/role/:idThis route is used to update one role by id - POSTSets the default role Id for new employees
/role/defaultThis route is used to update the defaultRoleId for new employees
B2B Employee Context
- GETList the employee contexts available to the logged-in account
/employee/contextReturns every active membership the current account can act as, whether a context selection is still required, and the account default. Requires the… - POSTList the employee contexts available to the logged-in account
/employee/contextReturns every active membership the current account can act as, whether a context selection is still required, and the account default. Requires the… - POSTSwitch the active employee context
/employee/context/switchActivates the given context for the current session and returns a new context token. Optionally sets or unsets that context as the account default. Requires… - POSTCancel a pending context selection
/employee/context/cancelClears the pending account that was staged during login when a context selection was required, returning the session to a clean state. Requires the…
B2B Order Approval
- GETFetch a list of approval rules
/approval-ruleThis route is used to load approval rules - POSTList all approval rules
/approval-ruleThis route is used to list all approval rules from the store - POSTCreate a new approval rule
/approval-rule/createThis route is used to create a new approval rule - GETFetch one approval rule by id
/approval-rule/:idThis route is used to fetch a approval rule from the store by id Available Associations: reviewerRole affectedRole - PATCHUpdate a approval rule by id
/approval-rule/:idThis route is used to update a approval rule from the store by id - POSTRequest new order approval
/pending-orders/requestThis route is used to request a new order approval - POSTFetch one pending order by id
/pending-order/:idThis route is used to fetch a pending order from the store by id - POSTFetch payment methods of a pending order
/pending-order/:id/payment-methodThis route is used to fetch the payment methods of a pending order - POSTDecline a pending order by id
/pending-order/:id/declineThis route is used to decline a pending order from the store by id - POSTApprove a pending order by id
/pending-order/:id/approveThis route is used to approve a pending order from the store by id - POSTCreate a order from a pending order
/pending-order/:id/checkout/orderThis route is used to create a order from a pending order
B2B Organization Units
- POSTCreate new organization unit
/organization-unitThis route is used to create a new organization - DELETEDelete organization units
/organization-unitThis route is used to delete organization units - POSTLoad Organization Units
/organization-unitsThis route is used to load all Organization Units - POSTLoad one Organization Unit
/organization-unit/:idThis route is used to load one Organization Unit Available Associations: customer parent employees children organizationCustomerAddresses shippingAddresses… - PATCHUpdate Organization Unit
/organization-unit/:idThis route is used to update Organization Unit
B2B Quote Management
- POSTRequest new quote
/quote/requestThis route is used to request a new quote from the store - POSTFetch a list of quotes
/quotesThis route is used to load quotes - GETFetch a one quote by id
/quote/:idThis route is used to fetch one quote by id - POSTFetch a one quote by id
/quote/:idThis route is used to fetch one quote by id Available Associations: stateMachineState currency language notificationRecipients notificationEmployees lineItems… - DELETEDelete a draft quote
/quote/:idThis route is used to delete a customer-owned draft quote by id - POSTFetch quote line items
/quote/:id/line-item-listingThis route loads the line items of a quote with filtering, sorting and paging support. - POSTFetch quote line item history
/quote/:id/line-item-history-listingThis route loads the line item history of a quote with filtering, sorting and paging support. - GETSearch products for quote line item management
/quote/:quoteId/product-searchThis route searches products and adds a quoteLineItem extension containing the active quote line item id for products already present in the quote. - POSTSearch products for quote line item management
/quote/:quoteId/product-searchThis route searches products and adds a quoteLineItem extension containing the active quote line item id for products already present in the quote. - POSTDecline a quote by id
/quote/:id/declineThis route is used to decline a quote from the store by id - POSTRequest change a quote by id
/quote/:id/request-changeThis route is used to request change a quote from the store by id - POSTSend a draft quote request
/quote/:id/send-requestThis route is used to send a customer-owned draft quote request by id - POSTCreate a draft quote version
/quote/:id/draft-versionThis route is used to create a temporary draft version for storefront quote editing. - DELETEDelete a draft quote version
/quote/:id/draft-versionThis route deletes the temporary storefront draft version identified by the versionId request payload. - POSTSave a draft quote version
/quote/:id/draft-version/saveThis route merges the current storefront draft version into the live quote. The request must include the versionId returned by the create endpoint in the… - POSTUpdate quote notification employee recipients
/quote/:id/notification-employeesThis route updates the employee notification recipients of a live quote by applying selected and deleted employee identifier lists. - POSTAdd a product line item to a quote
/quote/:id/line-item/addThis route is used to add a product line item to a quote from the store by id - POSTEdit a quote line item
/quote/:quoteId/line-item/:lineItemId/editThis route is used to change quantity and requested price of a quote line item from the store - PATCHEdit a quote line item
/quote/:quoteId/line-item/:lineItemId/editThis route is used to change quantity and requested price of a quote line item from the store - POSTRemove a quote line item
/quote/:quoteId/line-item/:lineItemId/removeThis route is used to remove a quote line item from the store - DELETERemove a quote line item
/quote/:quoteId/line-item/:lineItemId/removeThis route is used to remove a quote line item from the store - POSTChange payment or shipping method
/quote/:id/configureThis route is used to change a payment or shipping method when place a order - POSTCreate a order from a quote
/quote/:id/orderThis route is used to create a order from a quote - POSTDownload a document
/quote/document/download/:documentId/:deepLinkCodeThis route is used to download a document - POSTFetch quote documents
/quote/:quoteId/documentsThis route is used to load quote documents by quote id with search and paging support - POSTSend a message to the merchant in the quote
/quote/:id/send-messageThis route is used to send a message to the merchant in the quote - POSTMark messages as read in a quote
/quote/:id/read-messageDeprecated. This route is used to mark all messages as read in the specified quote draft version. - POSTMark quote history entries and comments as seen
/quote/:id/history/readThis route marks merchant-created quote history entries as seen. If quoteLineItemId is provided, quote line item history entries and comments for that line… - POSTReply to a quote comment
/quote/:id/comment/replyThis route creates a reply comment in the specified quote draft version. - DELETERemove a quote comment
/quote/:id/comment/:commentIdThis route deletes an owned comment in the specified quote draft version. - PATCHEdit a quote comment
/quote/:id/comment/:commentIdThis route edits an owned comment in the specified quote draft version.
B2B Shopping Lists
- POSTCreate new shopping list
/shopping-listThis route is used to create a new shopping list from the store - DELETEDelete shopping lists
/shopping-listThis route is used to delete shopping lists - POSTLoad shopping lists
/shopping-listsThis route is used to load all shopping lists - POSTLoad one shopping list
/shopping-list/:idThis route is used to load one shopping list Available Associations: customer employee lineItems organization - PATCHUpdate shopping list name
/shopping-list/:id/change-nameThis route is used to update shopping list name - POSTDuplicate new shopping list
/shopping-list/:id/duplicateThis route is used to duplicate a new shopping list from the store - GETPrice summary for shopping list
/shopping-list/:id/summaryThis route is used to get a price summary for shopping list - POSTAdd more product to shopping list
/shopping-list/:id/addThis route is used to add more products to shopping list - POSTDelete shopping list line items
/shopping-list/line-item/removeThis route is used to delete shopping list line items - POSTUpdate shopping list line item quantity
/shopping-list/line-item/:id/change-quantityThis route is used to update shopping list line item quantity - POSTAdd shopping lists to cart
/shopping-lists/add-to-cartThis route is used to add shopping lists to cart
Order Return Management
- POSTCreate an order return
/order/:orderId/returnCreate a return for an order of the logged-in customer.
Sso
- POSTAuthenticates via SSO
/sso/auth/:providerIdAuthenticates login via a given SSO provider ID - POSTRedirects after authentication
/sso/redirect/:providerIdRedirects after authenticated login via a given SSO provider ID
Profile
- POSTFetch newsletter recipients
/account/newsletter-recipientPerform a filtered search for newsletter recipients. - POSTChange the customer's information
/account/change-profileMake changes to a customer's account, like changing their name, salutation or title. - POSTChange the customer's email address
/account/change-emailChanges a customer's email address to a new email address, using their current password as a validation. - POSTChange the customer's language.
/account/change-languageChanges the language of the logged in customer - POSTChange the customer's password
/account/change-passwordChanges a customer's password using their current password as a validation. - POSTConvert a guest customer to a registered customer
/account/convert-guestTakes a password to convert a guest customer to a registered customer. The customer can then log in with the provided password in the future. - POSTChecks if the customer recovery entry for a given hash is expired.
/account/customer-recovery-is-expiredThis can be used to validate a provided hash has a valid and not expired customer recovery hash. - POSTGet information about current customer
/account/customerReturns information about the current customer. Available Associations: group - Customer group determining pricing and permissions language - Preferred… - DELETEDelete the customer's profile
/account/customerDeletes a customer profile along with their addresses, wishlists and associated data. Created orders and their payment/shipping information (addresses) and… - POSTReset a password with recovery credentials
/account/recovery-password-confirmThis operation is Step 2 of the password reset flow. It is required to conduct Step 1 "Send a password recovery mail" in order to obtain the required… - POSTSend a password recovery mail
/account/recovery-passwordThis operation is Step 1 of the password reset flow. Make sure to implement Step 2 "Reset password with recovery credentials" in order to allow for the…
Address
- DELETEDelete an address of a customer
/account/address/:addressIdDelete an address of customer. Only addresses which are not set as default addresses for shipping or billing can be deleted. You can check the current default… - PATCHModify an address of a customer
/account/address/:addressIdModifies an existing address of a customer. - POSTFetch addresses of a customer
/account/list-addressLists all addresses of the current customer and allows filtering them based on a criteria. - PATCHChange a customer's default shipping address
/account/address/default-shipping/:addressIdUpdates the default (preselected) shipping addresses of a customer. - PATCHChange a customer's default billing address
/account/address/default-billing/:addressIdUpdates the default (preselected) billing addresses of a customer. - POSTCreate a new address for a customer
/account/addressCreates a new address for a customer.
Login & Registration
- POSTLog in a customer
/account/loginLogs in customers given their credentials. - POSTImitate the log in as a customer
/account/login/imitate-customerImitate the log in as a customer given a generated token. - POSTLog out a customer
/account/logoutLogs out a customer. - POSTConfirm a customer registration
/account/register-confirmConfirms a customer registration when double opt-in is activated. Learn more about double opt-in registration in our guide "Register a customer". - POSTRegister a customer
/account/registerRegisters a customer. Used both for normal customers and guest customers.See the Guide "Register a customer" for more information on customer registration. - GETFetch registration settings for customer group
/customer-group-registration/config/:customerGroupId
App system
- POSTGenerate JWT token for app system backend
/app-system/:name/generate-tokenGenerate JWT token for authenticated communication with the app server
Category
- GETFetch a list of categories
/categoryPerform a filtered search for categories. Available Associations: children - Child categories within this category for hierarchical navigation media -… - POSTFetch a list of categories
/categoryPerform a filtered search for categories. Available Associations: children - Child categories within this category for hierarchical navigation media -… - GETFetch a single category
/category/:navigationIdThis endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category.… - POSTFetch a single category
/category/:navigationIdThis endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category.… - GETFetch a navigation menu
/navigation/:activeId/:rootIdThis endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth… - POSTFetch a navigation menu
/navigation/:activeId/:rootIdThis endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth…
Cart
- GETCalculate shipping costs for a product
/shipping-cost/product/:productIdCalculates shipping costs for a single product using criteria-based shipping method selection. - GETCalculate shipping costs for the cart
/shipping-cost/cartCalculates shipping costs for the current cart across available shipping methods. - GETFetch or create a cart
/checkout/cartUsed to fetch the current cart or for creating a new one. - DELETEDelete a cart
/checkout/cartThis route deletes the cart of the customer. - POSTAdd items to the cart
/checkout/cart/line-itemThis route adds items to the cart. An item can be a product or promotion for example. They are referenced by the referencedId-parameter. Example: Working with… - DELETERemove items from the cart
/checkout/cart/line-item?ids=stringDeprecated. DEPRECATED: use removeLineItem instead. This route removes items from the cart and recalculates it. Example: Working with the cart - Guide - PATCHUpdate items in the cart
/checkout/cart/line-itemThis route updates items in the cart. A typical example is updating the quantity of an item. Example: Working with the cart - Guide - POSTRemove items from the cart
/checkout/cart/line-item/deleteThis route removes items from the cart and recalculates it. Example: Working with the cart - Guide
Order
- POSTCreate an order from a cart
/checkout/orderCreates a new order from the current cart and deletes the cart. If you are using the prepared payment flow, this endpoint also receives additional transaction… - POSTCancel an order
/order/state/cancelCancels an order. The order state will be set to 'cancelled'. - POSTFetch a list of orders
/orderList orders of a customer. Available Associations: stateMachineState - Current order state (e.g., open, in_progress, completed, cancelled)… - POSTUpdate the payment method of an order
/order/paymentChanges the payment method of a specific order. You can use the /order route to find out if the payment method of an order can be changed - take a look at the… - GETDownload a purchased file
/order/download/:orderId/:downloadIdDownload a file included in the given order and with the given id. Access must be granted.
Gateway
- GETCall the checkout gateway
/checkout/gatewayCall the checkout gateway, which is used to manipulate certain aspects of the checkout process (e.g. available payment methods). - GETCall the context gateway
/context/gateway?appName=stringCall the context gateway, which is used to manipulate certain aspects of context (e.g. selected payment methods, register customer, etc.). Please prefer using… - POSTCall the context gateway
/context/gatewayCall the context gateway, which is used to manipulate certain aspects of context (e.g. selected payment methods, register customer, etc.).
Content
- GETFetch and resolve a CMS page
/cms/:idLoads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on. Important notice The… - POSTFetch and resolve a CMS page
/cms/:idLoads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on. Important notice The… - POSTSubmit a contact form message
/contact-formUsed for submitting contact forms. Be aware that there can be more required fields, depending on the system settings. - GETFetch a landing page with the resolved CMS page
/landing-page/:landingPageIdLoads a landing page by its identifier and resolves the CMS page. Important notice The criteria passed with this route also affects the listing, if there is… - POSTFetch a landing page with the resolved CMS page
/landing-page/:landingPageIdLoads a landing page by its identifier and resolves the CMS page. Important notice The criteria passed with this route also affects the listing, if there is… - GETFetch and resolve Media Entities
/media?ids[]=stringFetch one or multiple Media Entities with the corresponding Identifier. - POSTFetch and resolve Media Entities
/mediaFetch one or multiple Media Entities with the corresponding Identifier. - POSTSubmit a revocation request form message
/revocation-request-formUsed for submitting revocation request forms. Be aware that there can be more required fields, depending on the system settings.
System & Context
- GETFetch the current context
/contextFetches the current context. This includes for example the customerGroup, currency, taxRules and many more. - PATCHModify the current context
/contextUsed for switching the context. A typical example would be changing the language or changing the currency. - GETFetch the states of a country
/country-state/:countryIdPerform a filtered search the states for a country - POSTFetch the states of a country
/country-state/:countryIdPerform a filtered search the states for a country - GETFetch countries
/countryPerform a filtered search for countries Available Associations: states - States/provinces/regions within the country - POSTFetch countries
/countryPerform a filtered search for countries Available Associations: states - States/provinces/regions within the country - GETFetch currencies
/currencyPerform a filtered search for currencies. - POSTFetch currencies
/currencyPerform a filtered search for currencies. - GETFetch languages
/languagePerform a filtered search for languages. Available Associations: locale - Locale defining regional settings (date, time, number formats) translationCode -… - POSTFetch languages
/languagePerform a filtered search for languages. Available Associations: locale - Locale defining regional settings (date, time, number formats) translationCode -… - GETFetch salutations
/salutationPerform a filtered search for salutations. - POSTFetch salutations
/salutationPerform a filtered search for salutations. - GETFetch shop settings
/shop-settingsReturns the sales-channel-resolved subset of the system configuration that headless frontends (e.g. Composable Frontends) need to render the shop consistently…
Wishlist
- POSTAdd a product to a wishlist
/customer/wishlist/add/:productIdAdds a product to a customers wishlist. Important constraints * Anonymous (not logged-in) customers can not have wishlists. * The wishlist feature has to be… - POSTFetch a wishlist
/customer/wishlistFetch a customer's wishlist. Products on the wishlist can be filtered using a criteria object. Important constraints * Anonymous (not logged-in) customers can… - POSTCreate a wishlist for a customer
/customer/wishlist/mergeCreate a new wishlist for a logged in customer or extend the existing wishlist given a set of products. Important constraints * Anonymous (not logged-in)… - DELETERemove a product from a wishlist
/customer/wishlist/delete/:productIdRemoves a product from a customer's wishlist. Important constraints * Anonymous (not logged-in) customers can not have wishlists. * The wishlist feature has… - POSTLoad customer wishlist product ids
/dsr/customer/wishlist-product-idsLoad customer wishlist product ids
Document
- GETDownload generated document
/document/download/:documentId/:deepLinkCodeReturns generated document to download. - POSTDownload generated document
/document/download/:documentId/:deepLinkCodeReturns generated document to download.
Product
- GETRender an EU GARAN label
/product/:productId/garan-labelThis route renders an EU GARAN label SVG for a product. - GETRender the EU legal guarantee notice
/legal-guarantee-noticeThis route renders the EU-harmonised legal guarantee notice SVG and the matching europa.eu "Your Europe" guarantees page link in the customer-facing language… - GETExport product export
/product-export/:accessKey/:fileName - GETFetch a product listing by category
/product-listing/:categoryIdFetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint. Available… - POSTFetch a product listing by category
/product-listing/:categoryIdFetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint. Available… - GETFetch cross-selling groups of a product
/product/:productId/cross-sellingThis route is used to load the cross sellings for a product. A product has several cross selling definitions in which several products are linked. The route… - POSTFetch cross-selling groups of a product
/product/:productId/cross-sellingThis route is used to load the cross sellings for a product. A product has several cross selling definitions in which several products are linked. The route… - GETFetch a single product
/product/:productIdThis route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined… - POSTFetch a single product
/product/:productIdThis route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined… - GETFetch a list of products
/productList products that match the given criteria. For performance reasons a limit should always be set. Available Associations: downloads - Downloadable files… - POSTFetch a list of products
/productList products that match the given criteria. For performance reasons a limit should always be set. Available Associations: downloads - Downloadable files… - GETFetch product reviews
/product/:productId/reviewsPerform a filtered search for product reviews. - POSTFetch product reviews
/product/:productId/reviewsPerform a filtered search for product reviews. - POSTSave a product review
/product/:productId/reviewSaves a review for a product. Reviews have to be activated in the settings. - GETFetch current purchase quantity limits for products
/product/purchase-limit?ids[]=stringReturns the current min/max/step purchase constraints for the given products, reflecting live stock or configured limitations. Intended for use on PDP to show… - GETSearch for a matching variant by product options.
/product/:productId/find-variant?options[]=stringPerforms a search for product variants and returns the best matching variant. - POSTSearch for a matching variant by product options.
/product/:productId/find-variantPerforms a search for product variants and returns the best matching variant. - GETSearch for products (suggest)
/search-suggest?search=stringCan be used to implement search previews or suggestion listings, that don’t require any interaction. - POSTSearch for products (suggest)
/search-suggestCan be used to implement search previews or suggestion listings, that don’t require any interaction. - GETSearch for products
/searchPerforms a search for products which can be used to display a product listing. - POSTSearch for products
/searchPerforms a search for products which can be used to display a product listing. - POSTFetch a product listing by criteria
/dsr/product-listingFetches a product listing for a given criteria. It also provides filters, sortings and property aggregations, analogous to the /product-listing endpoint.
Payment & Shipping
- GETInitiate a payment for an order
/handle-payment?orderId=stringThis generic endpoint is should be called to initiate a payment flow after an order has been created. The details of the payment flow can differ depending on… - POSTInitiate a payment for an order
/handle-paymentThis generic endpoint is should be called to initiate a payment flow after an order has been created. The details of the payment flow can differ depending on… - GETFetch shipping methods
/shipping-methodPerform a filtered search for shipping methods. Available Associations: prices - Shipping method price configurations (graduated prices, quantity-based… - POSTFetch shipping methods
/shipping-methodPerform a filtered search for shipping methods. Available Associations: prices - Shipping method price configurations (based on current cart and context)…
System Info & Health Check
- GETGet API routes
/_info/routes - GETGet OpenAPI Specification
/_info/openapi3.jsonGet information about the store API in OpenAPI format.
MCP
- POSTMCP JSON-RPC endpoint (Store API)
/_mcpHandles Model Context Protocol (MCP) requests using the Streamable HTTP transport for the Store API. Accepts JSON-RPC 2.0 messages. Requires a valid Store API… - DELETEClose MCP session (Store API)
/_mcpTerminates the active MCP session identified by the mcp-session-id header. Experimental API, not part of our backwards compatibility promise, thus this API…
Newsletter
- POSTConfirm a newsletter registration
/newsletter/confirmYou have to use the hash from the link sent out via email to confirm the user registration. - POSTCreate or remove a newsletter subscription
/newsletter/subscribeThis route is used to create/remove/confirm a newsletter subscription. The option property controls what should happen: * direct: The subscription is directly… - POSTRemove a newsletter subscription
/newsletter/unsubscribeRemoves a newsletter recipient from the mailing lists.
Payment Method
- GETLoads all available payment methods
/payment-method - POSTLoads all available payment methods
/payment-method
API
- GETAccess point for different api logics which are provided by apps over script hooks
/script/:hook - POSTAccess point for different api logics which are provided by apps over script hooks
/script/:hook
Sitemap & Routes
- GETFetch SEO routes
/seo-urlPerform a filtered search for seo urls. - POSTFetch SEO routes
/seo-urlPerform a filtered search for seo urls. - GETFetch sitemaps
/sitemapFetches a list of compressed sitemap files, which are often used by search engines. - GETDownload sitemap file
/sitemap/:filePathDownloads the sitemap file from the configured sitemap storage.
Form Mail
- POSTSend message through form
/swag/cms-extensions/form
Customer account
- POSTUpdate customer default info
/dsr/account/update-default-infoMark the customer who was created by admin from DSR has already updated the default info when the customer first login - POSTGenerate login token that can be used to login to Storefront from DSR
/dsr/customer/generate-login-tokenGenerate login token that can be used to login to Storefront from DSR - POSTAutomatic login from DSR to Storefront
/dsr/customer/automatic-loginAutomatic login from DSR to Storefront - POSTMigrate visitor session from DSR to Storefront
/dsr/customer/migrate-visitor-sessionMigrate visitor session from DSR to Storefront
Appointment
- POSTJoin a meeting as a attendee
/dsr/appointment/:presentationPath/join-as-clientReturns the client join appointment response. - GETGet the appointment's basic settings
/dsr/appointment/:presentationPath/basic-settingGet all the basic settings of the appointment - GETGet the last seen products for the current attendee
/dsr/appointment/collection/last-seenReturns the the last seen products for the requesting client - POSTAdd a product to the attendee product list
/dsr/appointment/collection/:alias/:productIdAdd a product with the alias to the product list of the attendee - DELETERemove a product with the alias from the for the attendee product collection
/dsr/appointment/collection/:alias/:productIdRemoves the product with the matching alias from of the attendee product collection - GETGet the product ids for the attendee in product collection with the matching alias
/dsr/appointment/collection/:aliasReturns the product ids for the requesting attendee and matching alias - POSTGet the ics file to import to your calendar
/dsr/appointment/:appointmentId/download-icsReturns the calendar file - PATCHRespond the appointment invitation
/dsr/appointment/:appointmentId/attendee/respond-invitationReturns the appointment invitation status - PATCHUpdate attendee information
/dsr/appointment/attendeeUpdate attendee information - POSTAdd a interaction to log
/dsr/interactionCreate a interaction log entry in a specific appointment - POSTCreate appointment request
/dsr/appointment/requestCreate a appointment request for a specific appointment - GETLoad line item ids of a shopping lists from appointment cache
/dsr/appointment/:appointmentId/shopping-listsLoad line item ids of a shopping lists from the appointment cache
Presentation
- GETFetch presentation structure and flat navigation
/dsr/appointment/presentationResolves the presentation structure and navigation by using the attendeeContext information. There will be NO Slot-Data inside call… - GETFetch resolved data for specific slide
/dsr/appointment/presentation/:presentationCmsPageId/slide/:sectionIdGives the resolved slot-data for the given slide index (slot-config) - POSTFetch all products for specific slide
/dsr/appointment/presentation/:presentationCmsPageId/slide/:sectionId/productsFetches all products for a specific slide - GETGet the current presentation state
/dsr/appointment/presentation/stateReturns the presentation state for all and the client - GETFetch a cms page for quickview with product data
/dsr/quickview/:productId/:cmsPageLayoutIdTakes a product identifier and returns the preconfigured quickview CMS layout (defined in SwagDigitalSalesRooms.config.quickviewPageId ) hydrated with the…
Shop pages
- GETLoad product detail page
/dsr/product/:productIdLoad product detail page with product id - GETGet shop pages
/dsr/shop-pages/:layoutNameGet shop pages by layout name
API details
- Base URL
https://demo-frontends.shopware.store/store-api- Authentication
- An API key in the sw-access-key header
An API key in the sw-context-token header - Operations
- 260 operations on 198 pathsPOST 152GET 74DELETE 18PATCH 16
2 marked deprecated - Main resources
- Endpoints supporting Criteria 34B2B Quote Management 31Product 22B2B Employee Management 16Store API 16System & Context 14B2B Budget Management 13Appointment 12B2B Order Approval 11B2B Shopping Lists 11
- Response formats
application/jsonapplication/xmlapplication/pdfapplication/vnd.api+json- Description format
- OpenAPI 3.2.0, API version
6.7.13.0 - Links
- OpenAPI document
- Listed from
- Shopware's published OpenAPI description (shopware/frontends) (MIT)
How to test the Shopware Store API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Shopware Store API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the sw-access-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Fetch a breadcrumb” (GET /breadcrumb/:id), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Shopware Store API?
This endpoint reference contains an overview of all endpoints comprising the Shopware Store API It is listed under E-commerce and has 260 endpoints.
Who publishes the Shopware Store API?
It is listed from Shopware's public API description (an OpenAPI document), not published by Shopware on Swastik Codes. Anyone who controls shopware.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Shopware Store API?
Requests go to https://demo-frontends.shopware.store/store-api. Endpoint paths are added to this base URL.
How do I authenticate with the Shopware Store API?
It accepts 2 methods: an API key in the sw-access-key header; an API key in the sw-context-token header.
How many endpoints does the Shopware Store API have?
260 operations on 198 paths (152 POST, 74 GET, 18 DELETE, 16 PATCH). The largest groups are Endpoints supporting Criteria, B2B Quote Management, Product, B2B Employee Management.
Is forking the Shopware Store API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.