fresh-advance/product-feed

Product Feed API for OXID eShop

v1.0.0 2025-12-07 14:41 UTC

Requires

• php: ^8.2

Requires (Dev)

• codeception/codeception: ^5.1
• codeception/module-asserts: ^3.0
• codeception/module-db: ^3.1
• codeception/module-filesystem: ^3.0
• codeception/module-webdriver: ^4.0
• mikey179/vfsstream: ~1.6.8
• oxid-esales/codeception-modules: dev-b-7.3.x
• oxid-esales/codeception-page-objects: dev-b-7.3.x
• oxid-esales/developer-tools: dev-b-7.3.x
• oxid-esales/examples-module: dev-b-7.3.x
• oxid-esales/oxideshop-ce: dev-b-7.3.x
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^2.0.2
• phpunit/phpunit: ~10.5.17
• squizlabs/php_codesniffer: ^3.10
• symfony/filesystem: ^6.4

Conflicts

• oxid-esales/oxideshop-ce: <7.3

proprietary

• modules
• eshop
• OXID

README

Features

Produces the feed of products in the JSON format suitable for various marketing channels.

The example structure of the feed:

{
  "products": [
    {
      "id": "12345",
      "brand": "Tea Company",
      "name": "Organic Earl Grey Tea",
      "short_description": "Classic black tea with bergamot aroma.",
      "long_description": "Hand-picked from Sri Lanka’s highlands...",
      "price": "9.99 EUR",
      "weight": "100 g",
      "category": "Black Tea",
      "image_url": "https://yourshop.com/images/earl-grey.jpg",
      "url": "https://yourshop.com/products/earl-grey",
      "availability": "in_stock",
      "enable_search": true,
      "last_updated": "2025-11-09T19:00:00Z"
    }
  ]
}

Limitations

• The current version is producing one feed with all the products, so having large catalog may lead to performance issues.
  • Please contact us with a request for more performant solutions if needed, it could be implemented in the future versions.

Branch compatibility

• Branch b-7.4.x is compatible with OXID Shop compilation 7.4.x
• Branch b-7.3.x is compatible with OXID Shop compilation 7.3.x - 7.4.x

Version compatibility

• Version v1.0.0 is compatible with OXID Shop compilation 7.3.x - 7.4.x

Installation

Module is available on packagist and installable via composer

composer require fresh-advance/product-feed
./vendor/bin/oe-eshop-doctrine_migration migrations:migrate fa_product_feed

Development installation

To be able running the tests and other preconfigured quality tools, please install the module as a root package.

The next section shows how to install the module as a root package by using the Fresh Advance Development Base.

In case of different environment usage, please adjust by your own needs.

Development installation on Fresh Advance Development Base

The installation instructions below are shown for the current Fresh Advance Development Base for shop 7.4. Make sure your system meets the requirements of the Development Base.

1. Ensure all docker containers are down to avoid port conflicts

2. Clone the SDK for the new project

echo MyProject && git clone https://github.com/Fresh-Advance/development.git $_ && cd $_

1. Clone the repository to the source directory

git clone --recurse-submodules https://github.com/Fresh-Advance/Product-Feed.git --branch=b-7.3.x ./source

1. Run the recipe to setup the development environment

./source/recipes/setup-development.sh

You should be able to access the shop with http://localhost.local and the admin panel with http://localhost.local/admin (credentials: [e-mail] / admin)

Running the tests and quality tools

Check the "scripts" section in the composer.json file for the available commands. Those commands can be executed by connecting to the php container and running the command from there, example:

make php
composer tests-coverage

Commands can be also triggered directly on the container with docker compose, example:

docker compose exec -T php composer tests-coverage

License

Please make sure you checked the License before using the module. License subscription can be bought on MB Arbatos Klubas website