> For the complete documentation index, see [llms.txt](https://docs.solutioo.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.solutioo.de/shopware/shopware6_en_us/reference-and-lookup/api-endpoints-reference.md). # 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 | Endpoint | Usage | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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) | Endpoint | Usage | | ----------------------------------------- | ------------------------------------------------------------------------ | | `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 | Endpoint | Usage | | --------------------------------------- | ----------------------------------------------------------------- | | `product-price`, `search/product-price` | Manage tiered/customer group prices and search them for deletion. | | `rule` | Price rules for customer group-specific prices. | ### Orders | Endpoint | Usage | | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | `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 | Endpoint | Usage | | ----------------------------- | -------------------------------------------- | | `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) | Endpoint | Usage | | ------------------------------------------- | ------------------------------------------ | | `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) | Endpoint | Usage | | -------------------------------------------------------------------------------- | --------------------------------------------------------------- | | `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](/shopware/shopware6_en_us/monitoring-and-logs/api-call-log.md) and [Analyze API Responses](/shopware/shopware6_en_us/monitoring-and-logs/analyze-api-responses.md). * **Bulk:** Prices are uploaded in packages; the package size is controlled by the **Price API Limit** field. {% hint style="info" %} API error messages (for example 400, 401, 404) are logged in the API Call Log together with the exact server response. This makes it considerably easier to trace the issue to the affected field or mapping. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.solutioo.de/shopware/shopware6_en_us/reference-and-lookup/api-endpoints-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.