API Endpoints (Reference)
The Shopware 6 API Connector communicates exclusively via the Shopware Admin API. This reference provides a complete overview of the endpoints used, grouped by topic. You do not need to know the endpoints for your day-to-day work – the connector selects them automatically. For understanding and troubleshooting, however, this overview is helpful.
Authentication
oauth/token
Retrieval of the bearer token. Two modes: client credentials (client_id, client_secret, grant_type=client_credentials) or password grant (username, password, grant_type=password, client_id=administration).
All further calls are made with the Authorization: Bearer {token} header. The connector renews the token automatically when it expires.
Catalog (products, categories, attributes, media)
product
Create products (POST) and update them (PATCH).
search/product
Search products – among other things for SKU matching (productNumber).
category, search/category
Create, update, and download categories (search with a limit of 500).
tag, search/tag
Create and search tags (matching by ID, then by name).
media, search/media, product-media
Upload and search media/images and assign them to the product.
product-manufacturer
Create and assign manufacturers.
unit
Units of measure.
property-group, property-group-option
Attributes (properties) and their option values.
Prices
product-price, search/product-price
Manage tiered/customer group prices and search them for deletion.
rule
Price rules for customer group-specific prices.
Orders
search/order
Incremental order download (autoIncrement filter, range filter gte).
order, order-address, order-delivery, order-transaction, order-line-item
Order and line data.
_action/order
Status transitions of an order (feedback to Shopware).
Customers & B2B
customer, search/customer
Create, update, and search customers.
customer-address
Ship-to/bill-to addresses.
customer-group
Customer groups.
atlantis-b2b-employee
B2B users (employees) created from contacts.
Master data (initial data / mapping)
payment-method, shipping-method
Payment and shipping methods.
tax, tax-rule
Tax rates and tax rules.
currency
Currencies.
sales-channel
Sales channels.
salutation, country, language
Salutations, countries/regions, languages.
state-machine, state-machine-transition
Order status and possible transitions.
Premium endpoints (plugin required)
solutioo-invoice-document, .../import, .../import/bulk, .../by-reference
Upload and management of PDF documents in the customer account.
solutioo-grouped-product, solutioo-grouped-product-assignment
Group items and their assignments.
Technical notes
HTTP methods:
GET,POST,PATCH,PUT,DELETE.Language reference: Translations are updated per language in a targeted way via a language header (PATCH).
Logging: When Developer Log is enabled, the request and response are stored in the API Call Log (status code, endpoint, JSON) – see API Call Log and Analyze API Responses.
Bulk: Prices are uploaded in packages; the package size is controlled by the Price API Limit field.
