Download the PHP package punchout-catalogs/punchout-catalog-spryker without Composer

PunchOutCatalogs Module

Punchout Catalog Module for Spryker eCommerce Platform

Important Changes

Since the 2.4.0 version it has been changed the way of punchout connection load.

1. Business Unit become optional in Gateway URL (Entry Point)

2. It is required to enter Buyer ID for cXML Setup Request in the following format:

Credential_Domain_Value/Credential_Identity_Value.

Example #1: AribaNetworkId/AN119990XX

Example #2: NetworkId/NID119990XX

Installation

B2C store additionally requires the spryker-feature/company-account feature.

Look at etc/integration-sample/*.patch patches as example of integration with Spryker B2B and B2C demo stores.

Documentation

Integration Documentation

Spryker Documentation

Testing

Running:

Custom cart mapping

Extending cart mapping behavior could be implemented by overriding PunchoutCatalog\Yves\PunchoutCatalog\PunchoutCatalogConfig class method:

If this opportunity is not enough, you could define your own plugin that should implement PunchoutCatalog\Yves\PunchoutCatalog\Mapper\CartTransferMapperPluginInterface and add it by overriding PunchoutCatalog\Yves\PunchoutCatalog\PunchoutCatalogDependencyProvider::getCartTransferMapperPlugins method.

Enable Yves Controllers in a new way (since Spryker version 202001)

Enable Yves Punchout routes in src/Pyz/Yves/Router/RouterDependencyProvider.php:

Enable Yves Controllers in a legacy way (before Spryker version 202001)

Register Punchout routes in src/Pyz/Yves/ShopApplication/YvesBootstrap.php:

Enable Zed Controllers in a new way (since Spryker version 202001)

Enable Zed Punchout routes in src/Pyz/Zed/Router/RouterConfig.php:

Troubleshooting

Issue with Auth Token Create Error

The punchout-catalog.error.auth.token.create error may happen if the spy_oauth_access_token.user_identifier field is too small for data which is storing in the field. By default it is varchar(1024).

Solution:

The easiest way to improve it is upgrading the field from varchar(1024) to LONGVARCHAR.

Create a scheme file #1: src/Pyz/Zed/PunchoutCatalog/Persistence/Propel/Schema/spy_oauth.schema.xml:

Create a scheme file #2: src/Pyz/Zed/PunchoutCatalog/Persistence/Propel/Schema/spy_oauth_revoke.schema.xml:

DB upgrade:

vendor/bin/console propel:install

Database Schema Definition

Issue with disappeared PunchOut menu item in admin panel ( related to spryker-eco/punchout-catalogs )

Possible Reason:

Using BREADCRUMB_MERGE_STRATEGY hides all custom menu items which are not defined in the config/Zed/navigation.xml file. See: https://docs.spryker.com/docs/scos/dev/back-end-development/extending-spryker/adding-navigation-in-the-back-office.html#defining-a-navigation-merge-strategy Strategy defined in the src/Pyz/Zed/ZedNavigation/ZedNavigationConfig.php file.

Solution:

Restore menu items for BREADCRUMB_MERGE_STRATEGY easily by adding the following code to the config/Zed/navigation.xml file:

And run the application:build-navigation-cache command if navigation menu is cached (store runs in production mode).

Example of OCI Cart mapping with many custom fields:

Example of OCI Cart mapping with integrated sale_bunch_quantity (and with NEW_ITEM-PRICEUNIT):

Example of OCI Cart mapping with sale_quantity (without NEW_ITEM-PRICEUNIT and divided prices):

sale_quantity = quantity / sales_bunch_quantity

Example of cXML Cart mapping:

Example of cXML Request mapping: