Export product data
Questions:
- How do I export product data?
Description:
Product information management (PIM) from TYRIOS is designed to be able to flexibly pass on product data to a wide variety of third-party systems. Classics such as product forwarding to the Google Merchant Centre or Facebook are supported, as is the real-time forwarding of product data to any third-party system.
The PIM basically offers three different export functions.
- the export framework
- the REST API interface
- the webhook interface for real-time updates
The export framework
The export framework supports export to predefined file formats - e.g. in the form of the Google product feed. Other new formats can also be easily integrated, so that product transfer to third-party systems is possible with little effort.
TYRIOS supports the following export formats as standard:
- "CSV"
- "Facebook Catalogue" (in Google feed format)
- "Google Products" (Google feed format in XML)
- "Google Local Products" (Google feed format in XML for locally available products)
- "Google Local Inventory" (inventory export for Google Local)
- "XML"
All standard export formats only pass on public data. Purchase prices are not passed on. This can be realised with individual export formats.
There are two ways to export via the export framework:
- via the export function in the customer area > Product management > Export article
- via the console:
php index.php -exportProductData -exporter "[export format]" -language [language abbreviation] -output [output file] -affiliate [affiliate ID]
If the export is to take place regularly, a cron job must be set up. Using Google Products as an example, this could look like this:
php index.php -exportProductData -exporter "Google Products" -language de -output ./export/productData.xml -affiliate 1
Using the console ensures that no export is unintentionally enabled. Export via a URL is therefore not possible.
The REST API interface
As usual with TYRIOS, all product data (including internal data) is available via the REST endpoint. Provided you have the appropriate user rights, the product data can be retrieved from the following URL:
https://[domain]/service/ProductManagement/products
The output is paginated(offset, length) and supports filtering by product data using the filter parameter(JSON structure).
product data can also be created, changed and deleted in real time via the REST API.
Access to the REST API depends on the user rights.
The webhook interface
A third-party system can be informed of changes in real time via webhooks. To do this, the system must be informed of the events for creating, editing and deleting an item. More information can be found in the development documentation on the use of webhooks.
the webhook function makes it possible for a third-party system to be kept up to date at all times and in real time. Manual synchronisation is therefore no longer necessary.