findologic / plentymarkets-rest-exporter-new
FINDOLOGIC exporter for exporting product data via the plentymarkets REST API
Installs: 869
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 6
Forks: 0
Open Issues: 1
Type:project
Requires
- php: >=8.1
- ext-json: *
- findologic/libflexport: ^3.1
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/promises: ^1.4
- nesbot/carbon: ^2.38
- php-units-of-measure/php-units-of-measure: ^2.1
- symfony/cache: ^5.1
- symfony/dotenv: ^5.2
- vasily-kartashov/log4php: ^4.1
Requires (Dev)
- dg/bypass-finals: ^1.4
- phpstan/phpstan: ^1.9
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.5
- symfony/console: ^5.1
- symfony/filesystem: ^5.1
- symfony/finder: ^5.1
- symfony/phpunit-bridge: ^5.2
- symfony/var-dumper: ^5.1
- dev-develop
- v2.3.0
- v2.2.0
- v2.1.0
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.0
- v1.2.1
- v1.2.0
- v1.1.1
- v1.1.0
- v1.0.0
- v0.8.0
- v0.7.1
- v0.7.0
- v0.6.1
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- v0.1.0
- dev-high_memory_issue
- dev-test_lower_variant_count
- dev-PLENTY-470-As-a-Plenty-customer-I-want-to-use-the-XML-variants-logic
- dev-main
- dev-create_plentyShop_class
- dev-refactor_export_to_separate_adapters
- dev-ACC-786_Migrate_Importer_to_Monolog_as_our_current_logging_framework_log4php_is_abandoned
This package is auto-updated.
Last update: 2024-11-13 21:58:52 UTC
README
Table of Contents
Synopsis
This is a work in progress rewrite of the findologic/plentymarkets-rest-export.
The Plentymarkets REST API is being called to get all necessary product data for FINDOLOGIC. The data is then wrapped to generate a FINDOLOGIC-consumable XML/CSV file. In the case of XML this could be multiple files.
Requirements
- PHP >= 7.4
- PHP JSON extension
- Composer
Installation
- Run
composer install
to install all required dependencies. - Copy
.env
to.env.local
, and set the configuration for the shop, you want to export the data from.
Running the export
- Run
bin/console export:start
. - When the export was successful, you may be able to find the exported CSV/XML file
in the
/export
directory.
- If you have a shopkey, see Using a shopkey to run the export.
- If debug mode is true, you may be able to find all requests/responses inside
of the
/var/debug
directory.
If you want to debug, read more about debugging the export.
Development
Directory structure
.github
Contains everything related to GitHub, including GitHub Actions.bin
Contains executables. E.g. Running the export.config
Contains configuration files. E.g Export configuration.var/debug
Contains Request/Responses after starting an export.var/export
Contains the exported XML(s)/CSV file(s).var/log
Contains the log of the last export.src
Contains all source code.tests
Contains all unit-tests.vendor
Contains source code of dependencies.
Running tests
Running tests is as simple as it gets. Either run composer test
,
or use your IDE to run the tests. When running them with the IDE
you may want to include phpunit.xml.dist
as alternative configuration file.
Using a shopkey to run the export
NOTE: Running an export with a shopkey requires the option IMPORT_DATA_URL
to be set in
your environment file!
You can also run the export for a specific shopkey by calling the export with an
additional shopkey parameter or bin/console export:start [shopkey]
.
When a shopkey is supplied, the EXPORT_xxx
environment variables may be ignored.
Configuration
Here is a short table that explains each configuration option. Configuration changes can be done in your environment files.
Debugging the export
If you want to debug the export, you can simply right-click bin/console
inside of the IDE and select "Debug 'export (PHP Script)'".
Setting the environment variable "DEBUG" to true
, will
automatically create request/response files inside of the var/debug
folder.
If you no longer need them, they can be cleared anytime running composer clear
,
or bin/clearExportFiles
.