Install the Marketplace Product Offer Prices Glue API

Last updated:
Edit on GitHub

This document describes how to integrate the Marketplace Product Offer Prices Glue API feature into a Spryker project.

Install feature core

Follow the steps below to install the Marketplace Product Offer Prices Glue API feature core.

Prerequisites

Install the required features:

NAME VERSION INSTALLATION GUIDE
Marketplace Product Offer Prices 202311.0 Install the Marketplace Product Offer Prices feature

1) Install the required modules

Install the required modules using Composer:

composer require spryker/product-offer-prices-rest-api:"^1.0.0" --update-with-dependencies
Verification

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
ProductOfferPricesRestApi spryker/product-offer-prices-rest-api

2) Set up database schema and transfer objects

Update the database and generate transfer changes:

console transfer:generate
console propel:install
console transfer:generate
Verification

Make sure that the src/Orm/Zed/ProductStorage/Persistence/Base/SpyProductConcreteStorage.php class contains the syncPublishedMessageForMappings public function.

Make sure the following changes have been applied in transfer objects:

TRANSFER TYPE EVENT PATH
RestProductOfferPriceAttributes class Created src/Generated/Shared/Transfer/RestProductOffersAttributesTransfer

3) Enable Product Offer Prices resources and relationships

Activate the following plugins:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProductOfferPricesResourceRoutePlugin Registers the product-offer-prices resource. Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication
ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin Registers the product-offer-prices resource as a relationship to product-offers. Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication
src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php 
<?php

namespace Pyz\Glue\GlueApplication;

use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;
use Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface;
use Spryker\Glue\MerchantProductOffersRestApi\MerchantProductOffersRestApiConfig;
use Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication\ProductOfferPricesResourceRoutePlugin;
use Spryker\Glue\ProductOfferPricesRestApi\Plugin\GlueApplication\ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin;

class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider
{
    /**
     * @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface>
     */
    protected function getResourceRoutePlugins(): array
    {
        return [
            new ProductOfferPricesResourceRoutePlugin(),
        ];
    }

    /**
     * @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection
     *
     * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface
     */
    protected function getResourceRelationshipPlugins(
        ResourceRelationshipCollectionInterface $resourceRelationshipCollection
    ): ResourceRelationshipCollectionInterface {
        $resourceRelationshipCollection->addRelationship(
            MerchantProductOffersRestApiConfig::RESOURCE_PRODUCT_OFFERS,
            new ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin()
        );

        return $resourceRelationshipCollection;
    }
}
Verification

Make sure that the ProductOfferPricesResourceRoutePlugin plugin is set up by sending the request GET https://glue.mysprykershop.com/product-offers/{{offerReference}}/product-offer-prices.

Make sure that the ProductOfferPriceByProductOfferReferenceResourceRelationshipPlugin plugin is set up by sending the request GET https://glue.mysprykershop.com/product-offers/{{offerReference}}?include=product-offer-prices. You should get product-offers with all product offer’s product-offer-prices as relationships.

Integrate the following related features:

FEATURE REQUIRED FOR THE CURRENT FEATURE INSTALLATION GUIDE
Marketplace Product Offer Prices + Wishlist Glue API ✓ Install the Marketplace Product Offer Prices + Wishlist Glue API