Install the Marketplace Product Offer + Wishlist Glue API
Edit on GitHubThis document describes how to integrate the Marketplace Product Offer + Wishlist Glue API feature into a Spryker project.
Install feature core
Follow the steps below to install the Marketplace Product Offer + Wishlist Glue API feature core.
Prerequisites
Install the required features:
NAME | VERSION | INSTALLATION GUIDE |
---|---|---|
Marketplace Wishlist | 202311.0 | Install Wishlist feature |
Marketplace Product Offer API | 202311.0 | Install the Marketplace Product Offer Glue API |
1) Install the required modules
Install the required modules using Composer:
composer require spryker/merchant-product-offer-wishlist-rest-api:"^1.0.0" --update-with-dependencies
Make sure that the following modules have been installed:
MODULE | EXPECTED DIRECTORY |
---|---|
MerchantProductOfferWishlistRestApi | spryker/merchant-product-offer-wishlist-rest-api |
2) Set up transfer objects
Generate transfer changes:
console transfer:generate
Make sure the following changes have been applied in transfer objects:
TRANSFER | TYPE | EVENT | PATH |
---|---|---|---|
WishlistItemRequest.productOfferReference | property | Created | src/Generated/Shared/Transfer/WishlistItemRequestTransfer |
RestWishlistItemsAttributes.productOfferReference | property | Created | src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer |
RestWishlistItemsAttributes.merchantReference | property | Created | src/Generated/Shared/Transfer/RestWishlistItemsAttributesTransfer |
3) Set up behavior
Activate the following plugins:
PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
---|---|---|---|
ValidMerchantProductOfferAddItemPreCheckPlugin | Validates merchant product offer in a wishlist item before the add item operation is executed. | Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist | |
ValidMerchantProductOfferUpdateItemPreCheckPlugin | Validates merchant product offer in a wishlist item before the update item operation is executed. | Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist | |
ProductOfferRestWishlistItemsAttributesMapperPlugin | Populates RestWishlistItemsAttributes.id with the following pattern: {WishlistItem.sku}_{WishlistItemTransfer.productOfferReference} . |
Spryker\Glue\MerchantProductOfferWishlistRestApi\Plugin\Wishlist | |
ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin | Checks if the requested wishlist item exists in the wishlist item collection. | Spryker\Zed\MerchantProductOfferWishlistRestApi\Communication\Plugin | |
MerchantByMerchantReferenceResourceRelationshipPlugin | Adds merchants resources as a relationship by the merchant references in the attributes. |
Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication |
src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php
<?php
namespace Pyz\Glue\GlueApplication;
use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;
use Spryker\Glue\MerchantsRestApi\Plugin\GlueApplication\MerchantByMerchantReferenceResourceRelationshipPlugin;
use Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface;
use Spryker\Glue\WishlistsRestApi\WishlistsRestApiConfig;
class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider
{
/**
* @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection
*
* @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface
*/
protected function getResourceRelationshipPlugins(
ResourceRelationshipCollectionInterface $resourceRelationshipCollection
): ResourceRelationshipCollectionInterface {
$resourceRelationshipCollection->addRelationship(
WishlistsRestApiConfig::RESOURCE_WISHLIST_ITEMS,
new MerchantByMerchantReferenceResourceRelationshipPlugin()
);
return $resourceRelationshipCollection;
}
}
src/Pyz/Zed/Wishlist/WishlistDependencyProvider.php
<?php
namespace Pyz\Zed\Wishlist;
use Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist\ValidMerchantProductOfferAddItemPreCheckPlugin;
use Spryker\Zed\MerchantProductOfferWishlist\Communication\Plugin\Wishlist\ValidMerchantProductOfferUpdateItemPreCheckPlugin;
use Spryker\Zed\Wishlist\WishlistDependencyProvider as SprykerWishlistDependencyProvider;
class WishlistDependencyProvider extends SprykerWishlistDependencyProvider
{
/**
* @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\AddItemPreCheckPluginInterface>
*/
protected function getAddItemPreCheckPlugins(): array
{
return [
new ValidMerchantProductOfferAddItemPreCheckPlugin(),
];
}
/**
* @return array<\Spryker\Zed\WishlistExtension\Dependency\Plugin\UpdateItemPreCheckPluginInterface>
*/
protected function getUpdateItemPreCheckPlugins(): array
{
return [
new ValidMerchantProductOfferUpdateItemPreCheckPlugin(),
];
}
}
src/Pyz/Glue/WishlistsRestApi/WishlistsRestApiDependencyProvider.php
<?php
namespace Pyz\Glue\WishlistsRestApi;
use Spryker\Glue\MerchantProductOfferWishlistRestApi\Plugin\Wishlist\ProductOfferRestWishlistItemsAttributesMapperPlugin;
use Spryker\Glue\WishlistsRestApi\WishlistsRestApiDependencyProvider as SprykerWishlistsRestApiDependencyProvider;
class WishlistsRestApiDependencyProvider extends SprykerWishlistsRestApiDependencyProvider
{
/**
* @return array<\Spryker\Glue\WishlistsRestApiExtension\Dependency\Plugin\RestWishlistItemsAttributesMapperPluginInterface>
*/
protected function getRestWishlistItemsAttributesMapperPlugins(): array
{
return [
new ProductOfferRestWishlistItemsAttributesMapperPlugin(),
];
}
}
src/Pyz/Zed/WishlistsRestApi/WishlistsRestApiDependencyProvider.php
<?php
namespace Pyz\Zed\WishlistsRestApi;
use Spryker\Zed\MerchantProductOfferWishlistRestApi\Communication\Plugin\ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin;
use Spryker\Zed\WishlistsRestApi\WishlistsRestApiDependencyProvider as SprykerWishlistsRestApiDependencyProvider;
class WishlistsRestApiDependencyProvider extends SprykerWishlistsRestApiDependencyProvider
{
/**
* @return array<\Spryker\Zed\WishlistsRestApiExtension\Dependency\Plugin\RestWishlistItemsAttributesDeleteStrategyPluginInterface>
*/
protected function getRestWishlistItemsAttributesDeleteStrategyPlugins(): array
{
return [
new ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin(),
];
}
}
Make sure that the ProductOfferRestWishlistItemsAttributesMapperPlugin
is set up by sending the request to GET https://glue.mysprykershop.com/wishlists/{{wishlistId}}?include=wishlist-items
. You should get attributes
in the response.
Make sure that the ValidMerchantProductOfferAddItemPreCheckPlugin
is set up by sending the request to POST https://glue.mysprykershop.com/wishlists/{{wishlistId}}/wishlist-items
. You should have the wishlist item added only when the product has the specified offer reference, offer is active and approved, and merchant, who owns it, is active and approved.
Make sure that the ValidMerchantProductOfferUpdateItemPreCheckPlugin
is set up by sending the request PATCH https://glue.mysprykershop.com/wishlists/{{wishlist_id}}/wishlist-items/{{wishlist_item_id}}
. You should have the wishlist item updated only when the product has the specified offer reference, offer is active and approved, and merchant, who owns it, is active and approved.
Make sure that the ProductOfferRestWishlistItemsAttributesDeleteStrategyPlugin
is set up by sending the request to DELETE https://glue.mysprykershop.com/wishlists/{{wishlistId}}/wishlist-items/{{wishlistItemId}}
. You should get the product offer wishlist item deleted.
Thank you!
For submitting the form