Shopware 6
Credentials
To use this component you need to create your own API access integration credentials:
Go to to create access to Shopware.
Component credentials configuration fields:
- API Base URI
-
A required string value. Indicates which URL base needs to be used.
- Client ID
-
A required string value.
- Client secret
-
A required string value.
Triggers
Get new and updated objects polling
Retrieves all the updated or created objects within a given time range.
Configuration fields
- Object type
-
A required dropdown. The object Type to be fetched.
- Emit behavior
-
An optional dropdown. Indicates emit objects behavior; emit individually (by default) or emit page.
- Size of polling page
-
An optional, positive integer. The default is 100 (maximum 500). Indicates the size of pages to be fetched
- Timestamp field to poll on
-
An optional string. Can be either
Last ModifiedorCreated(updated or new objects, respectively). Defaults toCreated. - Start time
-
An optional string. Indicates the beginning time to start retrieving events from in ISO 8601 Date time UTC format;
YYYY-MM-DDThh:mm:ssZ. - End time
-
An optional string. The default is execution date. If provided, do not fetch records created or modified after this time in ISO8601 Date time UTC format:
YYYY-MM-DDThh:mm:ssZ.
Actions
Lookup objects (plural)
Lookup a set of objects defined by a criteria list. Can be emitted differently.
Configuration fields
- Object Type
-
A required dropdown. Object-type to lookup on. For example,
User. - Emit Behavior
-
A required dropdown. Defines the way result objects will be emitted, can be emit all, emit page, or emit individually.
Input metadata
- Search Criteria
-
A required array of strings. The search terms on which to filter objects. Search terms are an array that will be used as values for filter parameters of the search.
By default, mapping is configured to use fields type, field, value. If you want to use another filter configuration, use advanced mode: [{ type: 'equals', field: 'firstName', value: 'John' }]
Additional fields will be added if the selected emit behavior is Emit page:
- Page Size
-
A number. Defaults to 500. Indicates the number of objects per page. Rangees from 0 to 500.
- Page Number
-
A number. The default is 0. Indicates index of page to be fetched.
Output metadata
- Emit All mode
-
An object, with key results that has an array as its value.
- Emit Page mode
-
An object with key results that has an array as its value (if page size > 0). Key
totalCountOfMatchingResultswhich contains the total number of results (not just on the page) that match the search criteria (if page size = 0). - Emit individually mode
-
Each object will fill the entire message.
Delete object by ID
Delete a single object using its ID.
Upsert object
Updates (if record found) or creates a new object.
Configuration fields
- Object Type
-
A required dropdown. Object-type to upsert. For example,
Customer. - Create or update existing object
-
A required dropdown. Options are Create new or Update existing.
- Make GET request after object created/updated
-
An optional checkbox. Make a GET request after an object is created or updated. If this is set to
false, only the object ID will be emitted.
Input metadata
If Make GET request after object created/updated is true:
- ID
-
A required string. The ID of the object to upsert. And dynamically generated fields according to chosen upsert schema.
If Make GET request after object created/updated is false:
- ID
-
An optional string. The ID of the object to upsert. And dynamically generated fields according to chosen upsert schema.
Output metadata
If Make GET request after object created/updated is true:
- ID
-
An optional string. The ID of the object to upsert. And dynamically generated fields according to chosen upsert schema.
If Make GET request after object created/updated is false:
- ID
-
An optional string. The ID of the object to upsert.
Lookup object (at most one)
Lookup a single object by a selected field that uniquely identifies it.
Configuration fields
- Object Type
-
A required string. Object-type to lookup on. For example,
Users. - Allow criteria to be omitted
-
An optional boolean. If this is selected The ID field becomes optional.
- Allow zero results
-
An optional boolean. When selected, if the object is not found, an empty object will be returned instead of an error.
Make raw request
Executes a custom request.
Configuration fields
- Don’t throw error on 404 Response
-
An optional boolean. If set to true, 404 HTTP responses are not treated as errors. Defaults to false.