New Source: Presta Shop

[sherifnada]

Tell us about the new integration you’d like to have

popular open source shopfront platform https://github.com/PrestaShop/PrestaShop/

Describe the context around this new integration

• Which team in your company wants this integration, what for? This helps us understand the use case.
• How often do you want to run syncs?
• If this is an API source connector, which entities/endpoints do you need supported?

Describe the alternative you are considering or using

What are you considering doing if you don’t have this integration through Airbyte?

┆Issue is synchronized with this Asana task by Unito

[vitaliizazmic]

Integration Vetting

PrestaShop is an Open Source e-commerce web application, which is written in PHP.

Server configuration

The first stable version of PrestaShop 1.7, 1.7.0.0, was released on November 7th, 2016. Further updates have been released since then.

To install the latest PrestaShop 1.7, we need a web server running PHP 7.1+ and any flavor of MySQL 5.0+ (MySQL, MariaDB, Percona Server, etc.). Versions between 1.7.0 and 1.7.6 work with PHP 5.6+.

PrestaShop enables merchants to give third-party tools access to their shop’s database through a CRUD API, otherwise called a web service.

By default, the webservice feature is disabled on PrestaShop and needs to be switched on before the first use.

Webhook-based? (no/partially/yes)

No

Available authentication modes (API key/Oauth/other)

Access key

Connecting to the data source

The PrestaShop web service uses the REST architecture

Testing access to the Webservice

Creating an account

Instance deployment is required.

How to populate the account with data?

Fake data can be populated while installing PrestaShop instance. But it also can be done entirely through the API or through the UI.

Available streams for sync

Resource schemas

The Webservices can output JSON resource schemas

By default simple list that returns the IDs of the resources is received. For returning all fields use display=full parameter.

Available resources

• Addresses
• Attachments
• Carriers
• Cart rules
• Carts
• Categories
• Combinations
• Configurations
• Contacts
• Content management system
• Countries
• Currencies
• Customer messages
• Customer threads
• Customers
• Customizations
• Deliveries
• Employees
• Groups
• Guests
• Image types
• Images
• Languages
• Manufacturers
• Messages
• Order carriers
• Order cart rules
• Order details
• Order histories
• Order invoices
• Order payments
• Order slip
• Order states
• Orders
• Price ranges
• Product customization fields
• Product feature values
• Product features
• Product option values
• Product options
• Product suppliers
• Products
• Search
• Shop groups
• Shop urls
• Shops
• Specific price rules
• Specific prices
• States
• Stock availables
• Stock movement reasons
• Stock movements
• Stocks
• Stores
• Suppliers
• Supply order details
• Supply order histories
• Supply order receipt histories
• Supply order states
• Supply orders
• Tags
• Tax rule groups
• Tax rules
• Taxes
• Translated configurations
• Warehouse product locations
• Warehouses
• Weight ranges
• Zones

Do any streams support incremental sync?

We can filter the expected result with the filter parameter

Some resources have date_add and date_upd, but they are optional.

Preparation scope & blockers

Instance deployment is required.

Other information/blockers

Singer Tap isn't available.

[keu]

look at this https://hub.docker.com/r/prestashop/prestashop/

[vitaliizazmic]

Are the account test credentials available in Lastpass?

Account test credentials doesn't available in Lastpass. To work with Source we can deploy instance locally using Docker image.

Task breakdown

• Populate source with data - fake data can be populated while installing PrestaShop instance.
• Installing PrestaShop instance. Create access key - 1-2h
• Create source scaffolding and populate schemas folder - API returns schemas for each resources but in XML format. - 5-6h
• Implement spec, check, and discover - 1-2h
• Implement Read
  • Create API base abstract class
  • Create Base stream abstract classes - 6-8h
  • Implement base abstract classes for incremental streams 5-7h
• Handle rate limiting - 3-4h
• Implement standard tests - 2-3h

[sherifnada]

@vitaliizazmic just seeing this now -- can we support just a subset of the available streams to start with? Just want to make sure we keep the scope of the PR manageable and add more endpoints as users request them. Streams that seem like the most valuable:

• Contacts
• Customers
• Carts
• Employees
• Orders
• Order invoices
• Order histories
• Order Details
• Products
• Shops
• Suppliers
• Stocks
• Stock Movements
• Taxes

If you have already implemented others we can keep those (no need to throw them away) but hopefully this can help focus the scope