Available Shopware APIs

B2B

Create a single role and return the role

X

Fetch a list of roles

X

Fetch a list of roles

X

Fetch a one role by ID

X

Update one role by ID

X

Delete a role by ID

X

Fetch available permissions

X

Sets the default role ID for new employees

X

Create a single employee and return the employee

X

Fetch a list of employees

X

Fetch one employee by ID

X

Update one employee by ID

X

Delete an employee by ID

X

Reinvite employee by ID

X

Experimental

Fetch search terms by natural language query

X

ACL role

List with basic information of ACL role resources

X

Create new ACL role resources

X

Detailed information about an ACL role resource

X

Delete an ACL role resource

X

Partially update information about an ACL role resource

X

App

List with basic information of app resources

X

Create new app resources

X

Detailed information about an app resource

X

Delete an app resource

X

Partially update information about an app resource

X

App action button

List with basic information of app action button resources

X

Create new app action button resources

X

Detailed information about an app action button resource

X

Delete an app action button resource

X

Partially update information about an app action button resource

X

App administration snippet

List with basic information of app administration snippet resources

X

Create new app administration snippet resources

X

Detailed information about an app administration snippet resource

X

Delete an app administration snippet resource

X

Partially update information about an app administration snippet resource

X

App CMS block

List with basic information of app CMS block resources

X

Create new app CMS block resources

X

Detailed information about an app CMS block resource

X

Delete an app CMS block resource

X

Partially update information about an app CMS block resource

X

App flow action

List with basic information of app flow action resources

X

Create new app flow action resources

X

Detailed information about an app flow action resource

X

Delete an app flow action resource

X

Partially update information about an app flow action resource

X

List with basic information of app flow event resources

X

Create new app flow event resources

X

Detailed information about an app flow event resource

X

Delete an app flow event resource

X

Partially update information about an app flow event resource

X

App payment method

List with basic information of app payment method resources

X

Create new app payment method resources

X

Detailed information about an app payment method resource

X

Delete an app payment method resource

X

Partially update information about an app payment method resource

X

App script condition

List with basic information of app script condition resources

X

Create new app script condition resources

X

Detailed information about an app script condition resource

X

Delete an app script condition resource

X

Partially update information about an app script condition resource

X

App template

List with basic information of app template resources

X

Create new app template resources

X

Detailed information about an app template resource

X

Delete an app template resource

X

Partially update information about an app template resource

X

Category

List with basic information of category resources

X

Create new category resources

X

Detailed information about a category resource

X

Delete a category resource

X

Partially update information about a category resource

X

CMS block

List with basic information of CMS block resources

X

Create new CMS block resources

X

Detailed information about a CMS block resource

X

Delete a CMS block resource

X

Partially update information about a CMS block resource

X

CMS page

List with basic information of CMS page resources

X

Create new CMS page resources

X

Detailed information about a CMS page resource

X

Delete a CMS page resource

X

Partially update information about a CMS page resource

X

CMS section

List with basic information of CMS section resources

X

Create new CMS section resources

X

Detailed information about a CMS section resource

X

Delete a CMS section resource

X

Partially update information about a CMS section resource

X

CMS slot

List with basic information of CMS slot resources

X

Create new CMS slot resources

X

Detailed information about a CMS slot resource

X

Delete a CMS slot resource

X

Partially update information about a CMS slot resource

X

Country

List with basic information of country resources

X

Create new country resources

X

Detailed information about a country resource

X

Delete a country resource

X

Partially update information about a country resource

X

Country state

List with basic information of country state resources

X

Create new country state resources

X

Detailed information about a country state resource

X

Delete a country state resource

X

Partially update information about a country state resource

X

Currency

List with basic information of currency resources

X

Create new currency resources

X

Detailed information about a currency resource

X

Delete a currency resource

X

Partially update information about a currency resource

X

Currency country rounding

List with basic information of currency country rounding resources

X

Create new currency country rounding resources

X

Detailed information about a currency country rounding resource

X

Delete a currency country rounding resource

X

Partially update information about a currency country rounding resource

X

Custom entity

List with basic information of custom entity resources

X

Create new custom entity resources

X

Detailed information about a custom entity resource

X

Delete a custom entity resource

X

Partially update information about a custom entity resource

X

Custom field

List with basic information of custom field resources

X

Create new custom field resources

X

Detailed information about a custom field resource

X

Delete a custom field resource

X

Partially update information about a custom field resource

X

Custom field set

List with basic information of custom field set resources

X

Create new custom field set resources

X

Detailed information about a custom field set resource

X

Delete a custom field set resource

X

Partially update information about a custom field set resource

X

Custom field set relation

List with basic information of custom field set relation resources

X

Create new custom field set relation resources

X

Detailed information about a custom field set relation resource

X

Delete a custom field set relation resource

X

Partially update information about a custom field set relation resource

X

Customer

List with basic information on customer resources

X

Create new customer resources

X

Detailed information about a customer resource

X

Delete a customer resource

X

Partially update information about a customer resource

X

Customer address

List with basic information of customer address resources

X

Create new customer address resources

X

Detailed information about a customer address resource

X

Delete a customer address resource

X

Partially update information about a customer address resource

X

Customer group

List with basic information of customer group resources

X

Create new customer group resources

X

Detailed information about a customer group resource

X

Delete a customer group resource

X

Partially update information about a customer group resource

X

Customer recovery

List with basic information of customer recovery resources

X

Create new customer recovery resources

X

Detailed information about a customer recovery resource

X

Delete a customer recovery resource

X

Partially update information about a customer recovery resource

X

Customer wishlist

List with basic information of customer wishlist resources

X

Create new customer wishlist resources

X

Detailed information about a customer wishlist resource

X

Delete a customer wishlist resource

X

Partially update information about a customer wishlist resource

X

Customer wishlist product

List with basic information of customer wishlist product resources

X

Create new customer wishlist product resources

X

Detailed information about a customer wishlist product resource

X

Delete a customer wishlist product resource

X

Partially update information about a customer wishlist product resource

X

Delivery time

List with basic information of delivery time resources

X

Create new delivery time resources

X

Detailed information about a delivery time resource

X

Delete a delivery time resource

X

Partially update information about a delivery time resource

X

Document

List with basic information of document resources

X

Create new document resources

X

Detailed information about a document resource

X

Delete a document resource

X

Partially update information about a document resource

X

Document base config

List with basic information of document base config resources

X

Create new document base config resources

X

Detailed information about a document base config resource

X

Delete a document base config resource

X

Partially update information about a document base config resource

X

Document base config sales channel

List with basic information of document base config sales channel resources

X

Create new document base config sales channel resources

X

Detailed information about a document base config sales channel resource

X

Delete a document base config sales channel resource

X

Partially update information about a document base config sales channel resource

X

Document type

List with basic information of document type resources

X

Create new document type resources

X

Detailed information about a document type resource

X

Delete a document type resource

X

Partially update information about a document type resource

X

Flow

List with basic information of flow resources

X

Create new flow resources

X

Detailed information about a flow resource

X

Delete a flow resource

X

Partially update information about a flow resource

X

Flow sequence

List with basic information of flow sequence resources

X

Create new flow sequence resources

X

Detailed information about a flow sequence resource

X

Delete a flow sequence resource

X

Partially update information about a flow sequence resource

X

Flow template

List with basic information of flow template resources

X

Create new flow template resources

X

Detailed information about a flow template resource

X

Delete a flow template resource

X

Partially update information about a flow template resource

X

Import export file

List with basic information of import export file resources

X

Create new import export file resources

X

Detailed information about an import export file resource

X

Delete an import export file resource

X

Partially update information about an import export file resource

X

Import export log

List with basic information of import export log resources

X

Create new import export log resources

X

Detailed information about an import export log resource

X

Delete an import export log resource

X

Partially update information about an import export log resource

X

Import export profile

List with basic information of import export profile resources

X

Create new import export profile resources

X

Detailed information about an import export profile resource

X

Delete an import export profile resource

X

Partially update information about an import export profile resource

X

Integration

List with basic information of integration resources

X

Create new integration resources

X

Detailed information about an integration resource

X

Delete an integration resource

X

Partially update information about an integration resource

X

Landing page

List with basic information of landing page resources

X

Create new landing page resources

X

Detailed information about a landing page resource

X

Delete a landing page resource

X

Partially update information about a landing page resource

X

Language

List with basic information of language resources

X

Create new language resources

X

Detailed information about a language resource

X

Delete a language resource

X

Partially update information about a language resource

X

Locale

List with basic information of locale resources

X

Create new locale resources

X

Detailed information about a locale resource

X

Delete a locale resource

X

Partially update information about a locale resource

X

Log entry

List with basic information of log entry resources

X

Create new log entry resources

X

Detailed information about a log entry resource

X

Delete a log entry resource

X

Partially update information about a log entry resource

X

Mail header footer

List with basic information of mail header footer resources

X

Create new mail header footer resources

X

Detailed information about a mail header footer resource

X

Delete a mail header footer resource

X

Partially update information about a mail header footer resource

X

Mail template

List with basic information of mail template resources

X

Create new mail template resources

X

Detailed information about a mail template resource

X

Delete a mail template resource

X

Partially update information about a mail template resource

X

Mail template type

List with basic information of mail template type resources

X

Create new mail template type resources

X

Detailed information about a mail template type resource

X

Delete a mail template type resource

X

Partially update information about a mail template type resource

X

Main category

List with basic information of main category resources

X

Create new main category resources

X

Detailed information about a main category resource

X

Delete a main category resource

X

Partially update information about a main category resource

X

Media

List with basic information of media resources

X

Create new media resources

X

Detailed information about a media resource

X

Delete a media resource

X

Partially update information about a media resource

X

Media default folder

List with basic information of media default folder resources

X

Create new media default folder resources

X

Detailed information about a media default folder resource

X

Delete a media default folder resource

X

Partially update information about a media default folder resource

X

Media folder

List with basic information of media folder resources

X

Create new media folder resources

X

Detailed information about a media folder resource

X

Delete a media folder resource

X

Partially update information about a media folder resource

X

Media folder configuration

List with basic information of media folder configuration resources

X

Create new media folder configuration resources

X

Detailed information about a media folder configuration resource

X

Delete a media folder configuration resource

X

Partially update information about a media folder configuration resource

X

Media thumbnail

List with basic information of media thumbnail resources

X

Create new media thumbnail resources

X

Detailed information about a media thumbnail resource

X

Delete a media thumbnail resource

X

Partially update information about a media thumbnail resource

X

Media thumbnail size

List with basic information of media thumbnail size resources

X

Create new media thumbnail size resources

X

Detailed information about a media thumbnail size resource

X

Delete a media thumbnail size resource

X

Partially update information about a media thumbnail size resource

X

Newsletter recipient

List with basic information of newsletter recipient resources

X

Create new newsletter recipient resources

X

Detailed information about newsletter recipient resource

X

Delete newsletter recipient resource

X

Partially update information about newsletter recipient resource

X

Notification

List with basic information of notification resources

X

Create new notification resources

X

Detailed information about a notification resource

X

Delete a notification resource

X

Partially update information about a notification resource

X

Number range

List with basic information of number range resources

X

Create new number range resources

X

Detailed information about a number range resource

X

Delete a number range resource

X

Partially update information about a number range resource

X

Number range sales channel

List with basic information of number range sales channel resources

X

Create new number range sales channel resources

X

Detailed information about a number range sales channel resource

X

Delete a number range sales channel resource

X

Partially update information about a number range sales channel resource

X

Number range state

List with basic information of number range state resources

X

Create new number range state resources

X

Detailed information about a number range state resource

X

Delete a number range state resource

X

Partially update information about a number range state resource

X

Number range type

List with basic information of number range type resources

X

Create new number range type resources

X

Detailed information about a number range type resource

X

Delete a number range type resource

X

Partially update information about a number range type resource

X

Order

List with basic information of order resources

X

Create new order resources

X

Detailed information about an order resource

X

Delete an order resource

X

Partially update information about an order resource

X

Order address

List with basic information of order address resources

X

Create new order address resources

X

Detailed information about an order address resource

X

Delete an order address resource

X

Partially update information about an order address resource

X

Order customer

List with basic information of order customer resources

X

Create new order customer resources

X

Detailed information about an order customer resource

X

Delete an order customer resource

X

Partially update information about an order customer resource

X

Order delivery

List with basic information of order delivery resources

X

Create new order delivery resources

X

Detailed information about an order delivery resource

X

Delete an order delivery resource

X

Partially update information about an order delivery resource

X

Order delivery position

List with basic information of order delivery position resources

X

Create new order delivery position resources

X

Detailed information about an order delivery position resource

X

Delete an order delivery position resource

X

Partially update information about an order delivery position resource

X

Order line item

List with basic information of order line item resources

X

Create new order line item resources

X

Detailed information about an order line item resource

X

Delete an order line item resource

X

Partially update information about an order line item resource

X

Order line item download

List with basic information of order line item download resources

X

Create new order line item download resources

X

Detailed information about an order line item download resource

X

Delete an order line item download resource

X

Partially update information about an order line item download resource

X

Order transaction

List with basic information of order transaction resources

X

Create new order transaction resources

X

Detailed information about an order transaction resource

X

Delete an order transaction resource

X

Partially update information about an order transaction resource

X

Order transaction capture

List with basic information of order transaction capture resources

X

Create new order transaction capture resources

X

Detailed information about an order transaction capture resource

X

Delete an order transaction capture resource

X

Partially update information about an order transaction capture resource

X

Order transaction capture refund

List with basic information of order transaction capture refund resources

X

Create new order transaction capture refund resources

X

Detailed information about an order transaction capture refund resource

X

Delete an order transaction capture refund resource

X

Partially update information about an order transaction capture refund resource

X

Order transaction capture refund position

List with basic information of order transaction capture refund position resources

X

Create new order transaction capture refund position resources

X

Detailed information about an order transaction capture refund position resource

X

Delete an order transaction capture refund position resource

X

Partially update information about an order transaction capture refund position resource

X

Payment method

List with basic information of payment method resources

X

Create new payment method resources

X

Detailed information about a payment method resource

X

Delete a payment method resource

X

Partially update information about a payment method resource

X

Plugin

List with basic information of plugin resources

X

Create new plugin resources

X

Detailed information about a plugin resource

X

Delete a plugin resource

X

Partially update information about a plugin resource

X

Product

List with basic information of product resources

X

Create new product resources

X

Detailed information about a product resource

X

Delete a product resource

X

Partially update information about a product resource

X

Product configurator setting

List with basic information of product configurator setting resources

X

Create new product configurator setting resources

X

Detailed information about a product configurator setting resource

X

Delete a product configurator setting resource

X

Partially update information about a product configurator setting resource

X

Product cross selling

List with basic information of product cross selling resources

X

Create new product cross selling resources

X

Detailed information about a product cross selling resource

X

Delete a product cross selling resource

X

Partially update information about a product cross selling resource

X

Product cross selling assigned products

List with basic information of product cross selling assigned products resources

X

Create new product cross selling assigned products resources

X

Detailed information about a product cross selling assigned products resource

X

Delete a product cross selling assigned products resource

X

Partially update information about a product cross selling assigned products resource

X

Product download

List with basic information of product download resources

X

Create new product download resources

X

Detailed information about a product download resource

X

Delete a product download resource

X

Partially update information about a product download resource

X

Product export

List with basic information of product export resources

X

Create new product export resources

X

Detailed information about a product export resource

X

Delete a product export resource

X

Partially update information about a product export resource

X

Product feature set

List with basic information of product feature set resources

X

Create new product feature set resources

X

Detailed information about a product feature set resource

X

Delete a product feature set resource

X

Partially update information about a product feature set resource

X

Product keyword dictionary

List with basic information of product keyword dictionary resources

X

Create new product keyword dictionary resources

X

Detailed information about a product keyword dictionary resource

X

Delete a product keyword dictionary resource

X

Partially update information about a product keyword dictionary resource

X

Product manufacturer

List with basic information of product manufacturer resources

X

Create new product manufacturer resources

X

Detailed information about a product manufacturer resource

X

Delete a product manufacturer resource

X

Partially update information about a product manufacturer resource

X

Product media

List with basic information of product media resources

X

Create new product media resources

X

Detailed information about a product media resource

X

Delete a product media resource

X

Partially update information about a product media resource

X

Product price

List with basic information of product price resources

X

Create new product price resources

X

Detailed information about a product price resource

X

Delete a product price resource

X

Partially update information about a product price resource

X

Product review

List with basic information on product review resources

X

Create new product review resources

X

Detailed information about a product review resource

X

Delete a product review resource

X

Partially update information about a product review resource

X

Product search config

List with basic information of product search config resources

X

Create new product search config resources

X

Detailed information about a product search config resource

X

Delete a product search config resource

X

Partially update information about a product search config resource

X

Product search config field

List with basic information of product search config field resources

X

Create new product search config field resources

X

Detailed information about a product search config field resource

X

Delete a product search config field resource

X

Partially update information about a product search config field resource

X

Product search keyword

List with basic information on product search keyword resources

X

Create new product search keyword resources

X

Detailed information about a product search keyword resource

X

Delete a product search keyword resource

X

Partially update information about a product search keyword resource

X

Product sorting

List with basic information on product sorting resources

X

Create new product sorting resources

X

Detailed information about a product sorting resource

X

Delete a product sorting resource

X

Partially update information about a product sorting resource

X

Product stream

List with basic information on product stream resources

X

Create new product stream of resources

X

Detailed information about a product stream resource

X

Delete a product stream resource

X

Partially update information about a product stream resource

X

Product stream filter

List with basic information of product stream filter resources

X

Create new product stream filter resources

X

Detailed information about a product stream filter resource

X

Delete a product stream filter resource

X

Partially update information about a product stream filter resource

X

Product visibility

List with basic information on product visibility resources

X

Create new product visibility resources

X

Detailed information about a product visibility resource

X

Delete a product visibility resource

X

Partially update information about a product visibility resource

X

Promotion

List with basic information on promotion resources

X

Create new promotion resources

X

Detailed information about a promotion resource

X

Delete a promotion resource

X

Partially update information about a promotion resource

X

Promotion discount

List with basic information of promotion discount resources

X

Create new promotion discount resources

X

Detailed information about a promotion discount resource

X

Delete a promotion discount resource

X

Partially update information about a promotion discount resource

X

Promotion discount prices

List with basic information of promotion discount prices resources

X

Create new promotion discount prices resources

X

Detailed information about a promotion discount prices resource

X

Delete a promotion discount prices resource

X

Partially update information about a promotion discount prices resource

X

Promotion individual code

List with basic information on promotion individual code resources

X

Create new promotion individual code resources

X

Detailed information about a promotion individual code resource

X

Delete a promotion individual code resource

X

Partially update information about a promotion individual code resource

X

Promotion sales channel

List with basic information on promotion sales channel resources

X

Create new promotion sales channel resources

X

Detailed information about a promotion sales channel resource

X

Delete a promotion sales channel resource

X

Partially update information about a promotion sales channel resource

X

Promotion setgroup

List with basic information of promotion setgroup resources

X

Create new promotion setgroup resources

X

Detailed information about a promotion setgroup resource

X

Delete a promotion setgroup resource

X

Partially update information about a promotion setgroup resource

X

Property group

List with basic information on property group resources

X

Create new property group resources

X

Detailed information about a property group resource

X

Delete a property group resource

X

Partially update information about a property group resource

X

Property group option

List with basic information of property group option resources

X

Create new property group option resources

X

Detailed information about a property group option resource

X

Delete a property group option resource

X

Partially update information about a property group option resource

X

Rule

List with basic information of rule resources

X

Create new rule resources

X

Detailed information about a rule resource

X

Delete a rule resource

X

Partially update information about a rule resource

X

Rule condition

List with basic information of rule condition resources

X

Create new rule condition resources

X

Detailed information about a rule condition resource

X

Delete a rule condition resource

X

Partially update information about a rule condition resource

X

Sales channel

List with basic information on sales channel resources

X

Create new sales channel resources

X

Detailed information about a sales channel resource

X

Delete a sales channel resource

X

Partially update information about a sales channel resource

X

Sales channel analytics

List with basic information on sales channel analytics resources

X

Create new sales channel analytics resources

X

Detailed information about a sales channel analytics resource

X

Delete a sales channel analytics resource

X

Partially update information about sales channel analytics resource

X

Sales channel domain

List with basic information on sales channel domain resources

X

Create new sales channel domain resources

X

Detailed information about a sales channel domain resource

X

Delete a sales channel domain resource

X

Partially update information about a sales channel domain resource

X

Sales channel type

List with basic information of sales channel type resources

X

Create new sales channel type of resources

X

Detailed information about a sales channel type resource

X

Delete a sales channel type resource

X

Partially update information about a sales channeltype resource

X

Salutation

List with basic information on salutation resources

X

Create new salutation resources

X

Detailed information about a salutation resource

X

Delete a salutation resource

X

Partially update information about a salutation resource

X

Scheduled task

List with basic information on scheduled task resources

X

Create new scheduled task resources

X

Detailed information about a scheduled task resource

X

Delete a scheduled task resource

X

Partially update information about a scheduled task resource

X

Script

List with basic information on script resources

X

Create new script resources

X

Detailed information about a script resource

X

Delete a script resource

X

Partially update information about a script resource

X

SEO URL

List with basic information of SEO URL resources

X

Create new SEO URL resources

X

Detailed information about an SEO URL resource

X

Delete an SEO URL resource

X

Partially update information about an SEO URL resource

X

SEO URL template

List with basic information on SEO URL template resources

X

Create new SEO URL template resources

X

Detailed information about an SEO URL template resource

X

Delete an SEO URL template resource

X

Partially update information about an SEO URL template resource

X

Shipping method

List with basic information on shipping method resources

X

Create new shipping method resources

X

Detailed information about a shipping method resource

X

Delete a shipping method resource

X

Partially update information about a shipping method resource

X

Shipping method price

List with basic information of shipping method price resources

X

Create new shipping method price resources

X

Detailed information about a shipping method price resource

X

Delete a shipping method price resource

X

Partially update information about a shipping method price resource

X

Snippet

List with basic information of snippet resources

X

Create new snippet of resources

X

Detailed information about a snippet resource

X

Delete a snippet resource

X

Partially update information about a snippet resource

X

Snippet set

List with basic information of snippet set resources

X

Create new snippet set of resources

X

Detailed information about a snippet set resource

X

Delete a snippet set resource

X

Partially update information about a snippet set resource

X

State machine

List with basic information of state machine resources

X

Create new state machine resources

X

Detailed information about a state machine resource

X

Delete a state machine resource

X

Partially update information about a state machine resource

X

State machine history

List with basic information of state machine history resources

X

Create new state machine history resources

X

Detailed information about a state machine history resource

X

Delete a state machine history resource

X

Partially update information about a state machine history resource

X

State machine state

List with basic information of state machine state resources

X

Create new state machine state resources

X

Detailed information about a state machine state resource

X

Delete a state machine state resource

X

Partially update information about a state machine state resource

X

State machine transition

List with basic information of state machine transition resources

X

Create new state machine transition resources

X

Detailed information about a state machine transition resource

X

Delete a state machine transition resource

X

Partially update information about a state machine transition resource

X

System config

List with basic information of system config resources

X

Create new system config resources

X

Detailed information about a system config resource

X

Delete a system config resource

X

Partially update information about a system config resource

X

Tag

List with basic information of tag resources

X

Create new tag resources

X

Detailed information about a tag resource

X

Delete a tag resource

X

Partially update information about a tag resource

X

Tax

List with basic information on tax resources

X

Create new tax resources

X

Detailed information about a tax resource

X

Delete a tax resource

X

Partially update information about a tax resource

X

Tax provider

List with basic information on tax provider resources

X

Create new tax provider resources

X

Detailed information about a tax provider resource

X

Delete a tax provider resource

X

Partially update information about a tax provider resource

X

Tax rule

List with basic information on tax rule resources

X

Create new tax rule resources

X

Detailed information about a tax rule resource

X

Delete a tax rule resource

X

Partially update information about a tax rule resource

X

Tax rule type

List with basic information of tax rule type resources

X

Create new tax rule type resources

X

Detailed information about a tax rule type resource

X

Delete a tax rule type resource

X

Partially update information about a tax rule type resource

X

Theme

List with basic information on theme resources

X

Create new theme resources

X

Detailed information about a theme resource

X

Delete a theme resource

X

Partially update information about a theme resource

X

Unit

List with basic information of unit resources

X

Create new units of resources

X

Detailed information about a unit resource

X

Delete a unit resource

X

Partially update information about a unit resource

X

User

List with basic information on user resources

X

Create new user resources

X

Detailed information about a user resource

X

Delete a user resource

X

Partially update information about a user resource

X

User access key

List with basic information of user access key resources

X

Create new user access key resources

X

Detailed information about a user access key resource

X

Delete a user access key resource

X

Partially update information about a user access key resource

X

User config

List with basic information of user config resources

X

Create new user config resources

X

Detailed information about a user config resource

X

Delete a user config resource

X

Partially update information about a user config resource

X

User recovery

List with basic information on user recovery resources

X

Create new user recovery resources

X

Detailed information about a user recovery resource

X

Delete a user recovery resource

X

Partially update information about a user recovery resource

X

Webhook

List with basic information on webhook resources

X

Create new webhook resources

X

Detailed information about a webhook resource

X

Delete a webhook resource

X

Partially update information about a webhook resource

X

Webhook event log

List with basic information of webhook event log resources

X

Create new webhook event log resources

X

Detailed information about a webhook event log resource

X

Delete a webhook event log resource

X

Partially update information about a webhook event log resource

X

System info & healthcheck

Get business events

X

Get open API specification

X

Check that the application is running

X

Get actions for flow builder

X

Get API information

X

Get the Shopware version

X

Usage data

Get information about the usage data approval request

X

System operations

Run scheduled tasks

X

Get the minimum schedules task interval

X

Run indexer

X

Iterate an indexer

X

Run indexer

X

Clear old cache folders

X

Get cache information

X

Clear caches

X

Send product indexing message

X

Clear and warm up caches

X

Consume messages from the message queue

X

Clear container caches

X

Order management

Transition an order transaction to new state

X

Transition an order to new state

X

Transition an order delivery to new state

X

Refund an order transaction capture

X

Document management

Reserve or preview a document number

X

Create documents for orders

X

Upload a file for a document

X

Mail operations

Send a mail

X

Validate a mail content

X

Preview a mail template

X

Bulk operations

Bulk edit entities

X

Asset management

Upload a file to a media entity

X

Presentation

Fetch presentation structure and flat navigation

X

Fetch resolved data for specific slide

X

Get the current presentation state

X

Fetch a CMS page for quickview with product data

X

Appointment

Join a meeting as a attendee

X

Get the last seen products for the current attendee

X

Add a product to the attendee product list

X

Remove a product with the alias from for the attendee product collection

X

Get the product IDs for the attendee in product collection with the matching alias

X

Respond the appointment invitation

X

Update attendee information

X

Add a interaction to log

X

Payment & shipping

Initiate a payment for an order

X

Endpoints supporting criteria

Fetch shipping methods

X

Wishlist

Fetch a wishlist

X

Add a product to a wishlist

X

Create a wishlist for a customer

X

Remove a product from a wishlist

X

Product

Fetch a list of products

X

Fetch product reviews

X

Fetch cross-selling groups of a product

X

Fetch a single product

X

Save a product review

X

Search for a matching variant by product options

X

Search for products (suggest)

X

Export product export

X

Content

Fetch a landing page with the resolved CMS page

X

Submit a contact form message

X

Newsletter

Confirm newsletter registration

X

Create or remove newsletter subscription

X

Remove newsletter subscription

X

App

Access point for different API logics which are provided by apps over script hooks

X

System & context

Fetch currencies

X

Fetch salutations

X

Fetch countries

X

Fetch the states of a country

X

Fetch languages

X

Fetch the current context

X

Modify the current context

X

Payment method

Loads all available payment methods

X

Login & registration

Fetch registration settings for customer group

X

Log in a customer

X

Log out a customer

X

Confirm a customer registration

X

Register a customer

X

Order

Fetch a list of orders

X

Cancel an order

X

Update the payment method of an order

X

Download a purchased file

X

Create an order from a cart

X

Sitemap & routes

Fetch SEO routes

X

Fetch site maps

X

Category

Fetch a list of categories

X

Fetch a single category

X

Fetch a navigation menu

X

Profile

Fetch newsletter recipients

X

Get information about current customer

X

Change the customer's information

X

Change the customer's email address

X

Change the customer's language

X

Change the customer's password

X

Change the customer's default payment method

X

Checks if the customer recovery entry for a given hash is expired

X

Delete the customer's profile

X

Reset a password with recovery credentials

X

Send a password recovery mail

X

Address

Fetch addresses of a customer

X

Delete an address of a customer

X

Modify an address of a customer

X

Change a customer's default shipping address

X

Change a customer's default billing address

X

Create new address for a customer

X

Cart

Fetch or create a cart

X

Delete a cart

X

Add items to the cart

X

Remove items from the cart

X

Update items in the cart

X

Remove items from the cart

X