Skip to main content

Shopware API Endpoints

A complete inventory of the Shopware Admin API endpoints the iPaaS.com integration uses, grouped by entity, with the authorization endpoint.

Portal Info

The Shopware portal these endpoints belong to is the Shopware Administration console for your own store. You reach it at your store's base URL with /admin appended (for example, https://your-store.example.com/admin). This URL varies for every store and environment, so substitute your own store's address wherever a console address is referenced.

API Endpoints Intro

The Shopware integration uses the Shopware 6 Admin API, a RESTful API that accepts and returns JSON. The base URL is your own Shopware store, and every endpoint listed in this article is served under the store's /api path.

Throughout this article, the placeholder [Base URL] represents your Shopware store root (for example, https://your-store.example.com). Full request paths therefore read as [Base URL]/api/.... Substitute your own store address for [Base URL].

The integration has been tested against Shopware 6.6.10.4. For the authoritative definition of each endpoint, refer to the Shopware Admin API reference (accessed 2026-06-25).

To look records up, the integration also uses Shopware's generic search pattern, POST [Base URL]/api/search/<entity>, where <entity> is the entity being searched (for example, customer, product, or order). The search criteria are supplied in the request body. This pattern is used wherever the integration needs to find existing records, in addition to the entity-specific endpoints below.

Table of Contents

Bulk Sync Endpoints

Bulk create or update records (POST)

[Base URL]/api/_action/sync

Customer Endpoints

Create a customer (POST)

[Base URL]/api/customer

Update a customer (PATCH)

[Base URL]/api/customer/{id}

Get a customer's addresses (GET)

[Base URL]/api/customer/{id}/addresses

Search customers (POST)

[Base URL]/api/search/customer

Create a customer address (POST)

[Base URL]/api/customer-address

Update a customer address (PATCH)

[Base URL]/api/customer-address/{id}

Search customer addresses (POST)

[Base URL]/api/search/customer-address

Customer Group Endpoints

Create a customer group (POST)

[Base URL]/api/customer-group

B2B Company and Employee Endpoints

Create a B2B business partner (company) (POST)

[Base URL]/api/b2b-business-partner

Create a B2B employee (POST)

[Base URL]/api/b2b-employee

Get a B2B employee (GET)

[Base URL]/api/b2b-employee/{id}

Update a B2B employee (PATCH)

[Base URL]/api/b2b-employee/{id}

Search B2B employees (POST)

[Base URL]/api/search/b2b-employee

Product Endpoints

Create a product (POST)

[Base URL]/api/product

Update a product (PATCH)

[Base URL]/api/product/{id}

Get a product's SEO URLs (GET)

[Base URL]/api/product/{id}/seo-urls

Get a product's sales-channel visibilities (GET)

[Base URL]/api/product/{id}/visibilities

Create a product configurator setting (POST)

[Base URL]/api/product-configurator-setting

Search product configurator settings (POST)

[Base URL]/api/search/product-configurator-setting

Search products (POST)

[Base URL]/api/search/product

Related Product (Cross-Selling) Endpoints

Create a cross-selling group (POST)

[Base URL]/api/product-cross-selling

Get a cross-selling group (GET)

[Base URL]/api/product-cross-selling/{id}

Get a cross-selling group's assigned products (GET)

[Base URL]/api/product-cross-selling/{id}/assigned-products

Get a product's cross-selling groups (GET)

[Base URL]/api/product/{id}/cross-sellings

Create a cross-selling assigned product (POST)

[Base URL]/api/product-cross-selling-assigned-products

Update a cross-selling assigned product (PATCH)

[Base URL]/api/product-cross-selling-assigned-products/{id}

Delete a cross-selling assigned product (DELETE)

[Base URL]/api/product-cross-selling-assigned-products/{id}

Search cross-selling assigned products (POST)

[Base URL]/api/search/product-cross-selling-assigned-products

Product Manufacturer Endpoints

Create a product manufacturer (POST)

[Base URL]/api/product-manufacturer

Property Group Endpoints

Create a property group (POST)

[Base URL]/api/property-group

Create a property group option (POST)

[Base URL]/api/property-group-option

Search property groups (POST)

[Base URL]/api/search/property-group

Search property group options (POST)

[Base URL]/api/search/property-group-option

Catalog Category Endpoints

Create a category (POST)

[Base URL]/api/category

Remove a category association (DELETE)

[Base URL]/api/<entity>/{id}/categories/{id}

This is a generic association-removal call: it detaches a category from another entity (such as a product) without deleting the category itself. Substitute the parent entity for <entity>.

Scale Unit Endpoints

Create a scale unit (POST)

[Base URL]/api/unit

Search scale units (POST)

[Base URL]/api/search/unit

Kit (Bundle) Endpoints

Create or update a product bundle (POST)

[Base URL]/api/bundle/upsert

Get a product bundle's assigned products (GET)

[Base URL]/api/product-bundle/{id}/bundle-assigned-products

Search product bundles (POST)

[Base URL]/api/search/product-bundle

Media Endpoints

Create a media record (POST)

[Base URL]/api/media

Update a media record (PATCH)

[Base URL]/api/media/{id}

Delete a media record (DELETE)

[Base URL]/api/media/{id}

Upload a file to a media record (POST)

[Base URL]/api/_action/media/{id}/upload

Search media records (POST)

[Base URL]/api/search/media

Create a media folder (POST)

[Base URL]/api/media-folder

Create a media folder configuration (POST)

[Base URL]/api/media-folder-configuration

Search media folders (POST)

[Base URL]/api/search/media-folder

Search default media folders (POST)

[Base URL]/api/search/media-default-folder

Create a product media assignment (POST)

[Base URL]/api/product-media

Delete a product media assignment (DELETE)

[Base URL]/api/product-media/{id}

Search product media assignments (POST)

[Base URL]/api/search/product-media

Order and Delivery Endpoints

Get an order (GET)

[Base URL]/api/order/{id}

Update an order (PATCH)

[Base URL]/api/order/{id}

Get an order's billing address (GET)

[Base URL]/api/order/{id}/billing-address

Get an order's deliveries (GET)

[Base URL]/api/order/{id}/deliveries

Get an order's line items (GET)

[Base URL]/api/order/{id}/line-items

Get an order's state-machine state (GET)

[Base URL]/api/order/{id}/state-machine-state

Get an order's transactions (GET)

[Base URL]/api/order/{id}/transactions

Search orders (POST)

[Base URL]/api/search/order

Recalculate an order (POST)

[Base URL]/api/_action/order/{id}/recalculate

Toggle automatic promotions on an order (POST)

[Base URL]/api/_action/order/{id}/toggleAutomaticPromotions

Add a product to an order (POST)

[Base URL]/api/_action/order/{id}/product/{id}

Create an order version (POST)

[Base URL]/api/_action/version/order/{id}

Merge an order version (POST)

[Base URL]/api/_action/version/merge/order/{id}

Create an order delivery (POST)

[Base URL]/api/order-delivery

Update an order delivery (PATCH)

[Base URL]/api/order-delivery/{id}

Delete an order delivery (DELETE)

[Base URL]/api/order-delivery/{id}

Create a partial shipment delivery (POST)

[Base URL]/api/_action/partial-shipment-delivery

Get an order line item (GET)

[Base URL]/api/order-line-item/{id}

Delete an order line item (DELETE)

[Base URL]/api/order-line-item/{id}

Transition an order line item state (POST)

[Base URL]/api/_action/order-line-item/state/{id}

Order State Transition Endpoints

Transition an order state (GET)

[Base URL]/api/_action/state-machine/order/{id}/state

Search state-machine states (POST)

[Base URL]/api/search/state-machine-state

Order Return Endpoints

Create an order return (POST)

[Base URL]/api/order-return

Get an order return (GET)

[Base URL]/api/order-return/{id}

Update an order return (PATCH)

[Base URL]/api/order-return/{id}

Get an order return's line items (GET)

[Base URL]/api/order-return/{id}/line-items

Add items to an order return (POST)

[Base URL]/api/_action/order/{id}/order-return/{id}/add-items

Create an order return through the proxy (POST)

[Base URL]/api/_proxy/order/{id}/return

Search order returns (POST)

[Base URL]/api/search/order-return

Create an order return line item (POST)

[Base URL]/api/order-return-line-item

Update an order return line item (PATCH)

[Base URL]/api/order-return-line-item/{id}

Search order return line items (POST)

[Base URL]/api/search/order-return-line-item

Create an order return line item reason (POST)

[Base URL]/api/order-return-line-item-reason

Search order return line item reasons (POST)

[Base URL]/api/search/order-return-line-item-reason

Shipping Method Endpoints

Get shipping methods (GET)

[Base URL]/api/shipping-method

Create a shipping method (POST)

[Base URL]/api/shipping-method

Get a shipping method (GET)

[Base URL]/api/shipping-method/{id}

Update a shipping method (PATCH)

[Base URL]/api/shipping-method/{id}

Search shipping methods (POST)

[Base URL]/api/search/shipping-method

Payment Method Endpoints

Get payment methods (GET)

[Base URL]/api/payment-method

Search payment methods (POST)

[Base URL]/api/search/payment-method

Warehouse and Inventory Endpoints

Get warehouses (GET)

[Base URL]/api/warehouse

Create a warehouse (POST)

[Base URL]/api/warehouse

Update a warehouse (PATCH)

[Base URL]/api/warehouse/{id}

Get a warehouse's groups (GET)

[Base URL]/api/warehouse/{id}/groups

Search warehouses (POST)

[Base URL]/api/search/warehouse

Get a warehouse group (GET)

[Base URL]/api/warehouse-group

Get a warehouse group's warehouses (GET)

[Base URL]/api/warehouse-group/{id}/warehouses

Search warehouse groups (POST)

[Base URL]/api/search/warehouse-group

Create a product-warehouse stock record (POST)

[Base URL]/api/product-warehouse

Search product-warehouse stock records (POST)

[Base URL]/api/search/product-warehouse

Reference Data Endpoints

Get a currency (GET)

[Base URL]/api/currency/{id}

Get custom fields (GET)

[Base URL]/api/custom-field

Get sales channels (GET)

[Base URL]/api/sales-channel

Get a tag (GET)

[Base URL]/api/tag/{id}

Remove a tag association (DELETE)

[Base URL]/api/<entity>/{id}/tags/{id}

This is a generic association-removal call: it detaches a tag from another entity (such as a product or order) without deleting the tag itself. Substitute the parent entity for <entity>.

Webhook Flow Endpoints

These endpoints set up the automatic-transfer flows in your Shopware store.

Create a flow (POST)

[Base URL]/api/flow

Get a flow (GET)

[Base URL]/api/flow/{id}

Update a flow (PATCH)

[Base URL]/api/flow/{id}

Delete a flow (DELETE)

[Base URL]/api/flow/{id}

Get a flow's sequences (GET)

[Base URL]/api/flow/{id}/sequences

Search flows (POST)

[Base URL]/api/search/flow

Create a flow sequence (POST)

[Base URL]/api/flow-sequence

Update a flow sequence (PATCH)

[Base URL]/api/flow-sequence/{id}

Authorization Endpoint

Obtain an access token (POST)

[Base URL]/api/oauth/token

The integration authenticates with Shopware using OAuth 2.0. The grant in use is the one you selected when configuring the connection, either the password grant or the client-credentials grant, as described in the Shopware Connections and Settings article. The access token is obtained and refreshed automatically by the integration, so subscribers do not manage tokens directly.

Related Articles
Shopware Connections and Settings
Microsoft Dynamics 365 Business Central API Endpoints
Acumatica API Endpoints
Shopware Installation Instructions
OroCommerce Integration API Endpoints
Did this answer your question?