How to Connect
Prerequisites
Before setting up the Shopware integration in iPaaS.com, ensure you have the following information:
Base URL:
The URL of your Shopware instance (e.g.,
https://yourshopwareinstance.com).
This URL must match the instance you want to integrate with and should NOT include a / at the end.
Client ID and Client Secret: To obtain these values follow the below steps:
Log in to the Shopware Administration Portal.
Navigate to Settings > System > Integrations.
Click Add Integration and assign the Admin role.
Copy the Client ID and Client Secret.
Click Save Integration.
Configure Subscription Settings
Navigate to the Shopware subscription settings in iPaaS.com and provide the following information:
Field | Description | Required | Example |
Name | A unique name for identifying the Shopware subscription in iPaaS.com. | Yes | Shopware Integration |
Version | Specifies the version of the Shopware API to use. | Yes | v1.1 |
API URL | The base URL of your Shopware instance. | Yes |
|
Grant Type | Specifies the method of authentication. Options are | Yes |
|
Client ID | The Client ID generated in the Shopware Admin Portal. | Yes | Your Client ID |
Client Secret | The Client Secret generated in the Shopware Admin Portal. | Yes | Your Client Secret |
Username | (Optional) Used with the | No |
|
Password | (Optional) Used with the | No | Your Password |
Language ID | (Optional) Specifies the language used for communication with Shopware’s API. | No |
|
Authentication Methods
Shopware offers two methods for obtaining an access token to authenticate REST APIs:
Option 1 - Client Credentials Grant
This method is typically used for machine-to-machine communications.
It requires the Client ID and Client Secret to generate an access token.
The access token remains valid for 10 minutes and must be regenerated using the same request with the Client ID and Client Secret.
This method does not generate a refresh token.
Option 2 - Resource Owner Password
This method is commonly used by the admin panel.
It requires the Username and Password of the Shopware portal where the integration exists.
The access token is valid for 10 minutes and comes with a refresh token. After the initial 10 minutes, the access token can be regenerated using the refresh token, allowing continuous access without needing the username and password again.
Initialization Support
The following types of data support initialization and can be transferred in bulk:
Location TO iPaaS.com
Location Group TO iPaaS.com
Shipping Method TO iPaaS.com
Throttling
Throttling ensures that Shopware’s API isn’t overwhelmed by excessive API calls, preserving system performance during heavy data transfers.
While the throttling fields are required, the values are pre-populated by the integration settings. For more details, refer to Subscription Configuration – Edit.