torqit/store-syndicator-bundle

There is no license information available for the latest version (v0.1.11) of this package.

v0.1.11 2023-07-18 11:58 UTC

Requires

• php: ~8.0.0 || ~8.1.0 || ~8.2.0
• ext-fileinfo: *
• ext-json: *
• pimcore/data-hub: ^1.5
• pimcore/pimcore: ^10.5
• shopify/shopify-api: ^4.2

Requires (Dev)

• codeception/codeception: ^4.1.12 || ^5.0.3
• codeception/module-asserts: ^2
• codeception/module-symfony: ^1.6.0 || ^3.1.0
• codeception/phpunit-wrapper: ^9
• phpstan/phpstan: ^1.2
• phpunit/phpunit: ^9.3

Unknown License

README

Exports Pimcore objects into e-commerce storefronts such as Shopify.

Currently, this bundle is designed to work only with a Shopify store, but could be expanded in the future to support other e-commerce frameworks.

Installation:

1. Run composer require torqit/store-syndicator-bundle in your project's terminal.
2. In the same terminal, run bin/console pimcore:bundle:enable StoreSyndicatorBundle
3. Then run bin/console pimcore:bundle:install StoreSyndicatorBundle

Setting up an export:

1. Create a new "TorqStoreExporterShopifyCredentials" Data Object with your Shopify store's credentials.
2. Create a new "Store Exporter" item in the Pimcore Datahub.
3. In your created Store Exporter, under the API Access tab, drag in your credentials object created in step 1.
4. Under the Choose Products tab
   1. Under BaseClass choose the Data Object class you will be exporting
   2. Under "Product Query Qhere Clause" you can write the SQL where clause for the pimcore object listing for the export. Some examples include:
      • o_path LIKE "your products folder path" for path based exports
      • fieldName = value for object field based export
5. In the Map Attributes tab, fill in the table with the appropriate details:
   • The "local field" column refers to the field on your Pimcore Data Object class to export
   • The "field type" column refers to the store field type
   • The "remote field" column refers to the field in your store
   • Check the "map on" checkbox for any fields that should be unique on all exported variants

Running an export:

In a terminal, run the command bin/console torq:push-to-shopify "your-store-name". If you expect this export to take longer than a few minutes (or you are exporting more than a few thousand variants), wrap the command with nohup as follows to ensure the process continues running if your terminal session ends unexpectedly: nohup bin/console torq:push-to-shopify "your-store-name" &.

Viewing Results:

The tab labeled "Execution", in a Store Exporter datahub config, contains a table of logs. This table will show any files or responses returned from API calls made while exporting your products, as well as any errors that shopify returns.