Install the Merchant Opening Hours Glue API

Last updated:
Edit on GitHub

This document describes how to integrate the Merchant Opening Hours Glue API feature into a Spryker project.

Install feature core

Follow the steps below to install the Merchant Opening Hours Glue API feature core.

Prerequisites

Install the required features:

NAME VERSION INSTALLATION GUIDE
Merchant Opening Hours 202311.0 Install the Merchant Opening Hours feature

1) Install the required modules

Install the required modules using Composer:

composer require spryker/merchant-opening-hours-rest-api:"^1.0.0"
Verification

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
MerchantOpeningHoursRestApi spryker/merchant-opening-hours-rest-api

2) Set up transfer objects

Generate transfer changes:

console transfer:generate
Verification

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

TRANSFER TYPE EVENT PATH
RestMerchantOpeningHoursAttributes class Created src/Generated/Shared/Transfer/RestMerchantOpeningHoursAttributesTransfer

3) Enable merchant product offers resources and relationships

Activate the following plugins:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
MerchantOpeningHoursResourceRoutePlugin Registers the merchant-opening-hours resource. Spryker\Glue\MerchantOpeningHoursRestApi\Plugin\GlueApplication
MerchantOpeningHoursByMerchantReferenceResourceRelationshipPlugin Registers the merchant-opening-hours resource as a relationship to the merchants resource. Spryker\Glue\MerchantOpeningHoursRestApi\Plugin\GlueApplication

src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php

<?php

namespace Pyz\Glue\GlueApplication;

use Spryker\Glue\MerchantsRestApi\MerchantsRestApiConfig;
use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;
use Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface;
use Spryker\Glue\MerchantOpeningHoursRestApi\Plugin\GlueApplication\MerchantOpeningHoursByMerchantReferenceResourceRelationshipPlugin;
use Spryker\Glue\MerchantOpeningHoursRestApi\Plugin\GlueApplication\MerchantOpeningHoursResourceRoutePlugin;

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

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

        return $resourceRelationshipCollection;
    }
}
Verification

Make sure that MerchantOpeningHoursByMerchantReferenceResourceRelationshipPlugin is set up by sending the request GET https://glue.mysprykershop.comm/merchants/{{merchant-reference}}?include=merchant-opening-hours. You should get merchants with all merchant opening hours as relationships.