About the Shopware 6 category

Alumio_Bot · September 21, 2022, 10:02am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Shopware 6 API Reference

Connector package documentation

1. Setting up HTTP Client Shopware 6

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Shopware 6 HTTP Client as PlatForm and click next step
Fill in the Base URI, Client ID and Client Secret for Client Credential Authentication.
Fill in the Base URI, Client ID, Client Secret, Username and Password for Password Authentication
(For more information, see Shopware 6 Authentication Reference)
Click on “Grant access to Shopware 6” and you will be redirected to approve the grant.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Shopware 6

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Shopware 6.5 Subscriber” as the subscriber.
Select the entity you want to subscribe to from Shopware 6.
Add any request parameters needed to subscribe to the entity.
Select the Shopware 6 HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Shopware 6.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Shopware 6 documentation on building this connector, so you can easily use the connector based on Shopware 6 API Reference.

Entity

The entity you want to subscribe to Shopware 6. Please refer to the entities from Shopware 6 API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Shopware 6 API Reference .

Please look at the example below on how to fill path field when subscribing “Product By ID” entity.

Based on the documentation, we can see that the end point require “id” as a parameter. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to Shopware 6 with the URL /api/product/123

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access Shopware 6.

3. Publishing Entity to Shopware 6

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Shopware 6.5 Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Shopware 6 entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP POST method, HTTP PATCH method and HTTP DELETE method on submitting data to Shopware 6.

Entity

We support publishing to most Shopware 6 endpoints.
Please refer to Shopware 6 API Reference page.

For example, we want to add a new contact. Please select “POST” as the Method and “Product” as the entity of the publisher.

Based on the documentation, it requires a body data for the request. That is why we set the body data inside the payload key inside Alumio data.

Alumio will send an API request to Shopware 6 with URL /api/product

Another example is when we want to delete a contact. Please select “DELETE” as the Method and “Product” as the entity of the publisher.