PunchOut for Vendure: OCI &amp; cXML via open-source plugin | PunchCommerce                       ![](//analytics.punchcommerce.de/matomo.php?idsite=1&rec=1)

  [Skip to content](#main-content)

  Integration · Vendure 3 PunchOut for Vendure. Your customer requires PunchOut, you run Vendure. You deliver with a plugin.
====================================================================================================

 Your key account wants to order in your shop straight from its procurement system, via OCI, cXML or IDS Connect. With the open-source plugin from Vendure's community plugins you connect your shop to the gateway: you install the plugin, add the entry and the cart transfer to your storefront and create the customer in PunchCommerce.

 [ Start free trial ](https://www.punchcommerce.de/register) [ See the setup ](#setup)

30 days free · no credit card · cancel anytime

  Protocols: OCI, cXML and IDS Connect 3

 for the open-source plugin €0

 per customer per month, plus VAT €49

 Plugin

One plugin for your Vendure back end, the gateway for your customer
-------------------------------------------------------------------

The plugin connects your Vendure back end to the PunchCommerce gateway; it only exchanges JSON over HTTPS with PunchCommerce, and PunchCommerce handles the protocol communication.

 For Vendure 3### PunchOut Gateway Plugin for Vendure

Open-source plugin for the gateway connection via OCI, cXML and IDS Connect, plus:

- Parallel PunchOut sessions with separate carts
- Shipping costs as a separate cart item, configurable
- Unit, packaging unit and weight per variant

  Version Vendure 3.0 or later

 Runtime a storefront you can modify

 Source npm package `@vendure-community/punchout-gateway-plugin`, source code in the vendurehq/community-plugins repository on GitHub

 License GPL-3.0-or-later, free of charge

 Account active PunchCommerce account

  [ View on GitHub (opens in a new window) ](https://github.com/vendurehq/community-plugins/tree/main/packages/punchout-gateway-plugin) [Plugin documentation](https://www.punchcommerce.de/de/documentation/vendure-punchout-erweiterung) [Vendure documentation (opens in a new window)](https://docs.vendure.io/current/community-plugins/punch-out-gateway-plugin)

 Configuration vendure-config.ts

 ```
import { PunchOutGatewayPlugin } from
    '@vendure-community/punchout-gateway-plugin';

export const config: VendureConfig = {
    plugins: [
        PunchOutGatewayPlugin.init({
            // without options the defaults apply
        }),
    ],
};
```

In the Vendure admin, enter the same value in the customer's field “PunchOut Customer ID (uID)” that you use in PunchCommerce as the customer identifier.

 Because Vendure is headless, meaning it only provides the back end while the storefront is yours, your storefront takes on three tasks: it receives the buyer on a PunchOut landing page, for example at your storefront address plus `/punchout`, keeps their cart per PunchOut session and returns it to the procurement system at the push of a button. The Vendure team provides a complete example storefront on GitHub as [punchcommerce-storefront-demo (opens in a new window)](https://github.com/vendurehq/punchcommerce-storefront-demo) for you to build on.

 The gateway handles the protocols: it talks to your customer's procurement system, for example SAP Ariba, Coupa, Jaggaer or SAP SRM, via [OCI PunchOut](https://www.punchcommerce.de/en/oci-punchout) or [cXML PunchOut](https://www.punchcommerce.de/en/cxml-punchout) and returns the cart in the right format. You set the protocol per customer in PunchCommerce. You connect plumbing, heating and electrical trade businesses via [IDS Connect](https://www.punchcommerce.de/en/ids-connect) from the same Vendure installation.

 Do you run further shops on other systems? Under [Integrations](https://www.punchcommerce.de/en/integrations) you will find all plugins, extensions and connection options.

 Setup

From plugin to go-live in six steps
-----------------------------------

All steps come from the plugin documentation. Steps two to four concern your storefront, which is where most of the work lies with Vendure. You do not have to implement a PunchOut protocol for this.

1. 1 You · back end### Install the plugin

    Install the npm package `@vendure-community/punchout-gateway-plugin` and register the plugin in vendure-config.ts. The defaults are enough to get started.
2. 2 You · storefront### Create the landing page

    Create a route such as `/punchout` in your storefront. It reads the session ID (sID) and the customer identifier (uID) from the address, stores the sID in sessionStorage and logs the buyer in via the authenticate GraphQL mutation.
3. 3 You · storefront### Bind the cart to the session

    Pass activeOrderInput with the sID on all order operations. Otherwise the items end up in the customer's regular cart instead of the cart of the PunchOut session.
4. 4 You · storefront### Replace checkout with transfer

    Replace the checkout with a button that transfers the cart via transferPunchOutCart. If your shop runs in an iFrame, set the session cookies to SameSite=None; Secure and remove the X-Frame-Options header during the PunchOut session.
5. 5 You · PunchCommerce### Create the customer

    Create your customer in PunchCommerce with the OCI, cXML or IDS Connect protocol, a unique customer identifier and the address of your landing page as the entry address. Enter the same value as the customer identifier in the Vendure admin in the field “PunchOut Customer ID (uID)”.
6. 6 You · PunchCommerce### Test and hand over

    Use the field mapping to define which shop data lands in which PunchOut field, and test the flow with the PunchOut simulator. Then pass the access details on to your customer.

###   What you need from your customer

- The protocol of their procurement system: OCI, cXML or IDS Connect
- The product classification key their system expects
- The units of measure they order in
- Access to their test system for the trial run

###   What you send your customer

- The PunchOut URL from PunchCommerce
- The access details, for cXML `Identity` and `SharedSecret`
- The access guide as a PDF from PunchCommerce

 Features

What the plugin offers your PunchOut customers
----------------------------------------------

All features are taken from the plugin documentation. After the transfer, the order in Vendure changes to the status “Transferred” and is kept there.

### Login via the uID

The plugin adds the field “PunchOut Customer ID (uID)” to customers in Vendure. If the value matches the customer identifier in PunchCommerce, your landing page logs the buyer in.

### Parallel sessions

Each PunchOut session gets its own empty cart. The same customer can open several sessions at once without the carts getting mixed up.

### Gross and net prices

Prices are sent to PunchCommerce as gross and net values. The plugin converts the cent amounts from Vendure into decimal values.

### Shipping costs as an item

You decide whether shipping costs appear as a separate cart item always, only when the value is above zero, or never.

### Units and weight per variant

You map unit, packaging unit and weight to fixed values or to custom fields of your product variants, with a default value as fallback.

### Field mapping and simulator

In PunchCommerce you map per customer which data lands in which field on your customer's side. You check the flow beforehand with the PunchOut simulator.

  Not supported: the detail, search and background-search calls, with which the procurement system retrieves individual items or search results directly from your shop. The entry and the cart transfer are not affected.

 Pricing

What PunchOut for Vendure costs
-------------------------------

The plugin is open source and free of charge. You pay per customer you connect in PunchCommerce. Hosting is GDPR-compliant in Germany.

 For your case Supplier · self-service setup### PunchCommerce Business

Gateway connection of your Vendure shop via OCI, cXML and IDS Connect, set up by you, without an agency. Three connected customers cost €147 per month, plus VAT.

 €49 per customer per month, plus VAT

Without your own shop: plus the Hosted Catalog add-on, €50 per customer per month, plus VAT.

 [ Start free trial ](https://www.punchcommerce.de/register)30 days free · no credit card · cancel anytime

 [Compare plans and pricing](https://www.punchcommerce.de/en/features-and-pricing)

 With SLA &amp; operational responsibility### PunchCommerce Enterprise

For suppliers who need availability with an uptime guarantee, defined escalation paths and someone responsible for operating their PunchOut connections.

 Custom based on SLA level and number of connections

 [ Schedule a consultation (opens in a new window) ](https://account.netzdirektion.de/appointments/punchcommerce)30 min · remote · with the founder

 [See PunchCommerce Enterprise](https://www.punchcommerce.de/en/enterprise)

 FAQ

Frequently asked questions about PunchOut for Vendure
-----------------------------------------------------

What Vendure teams want to know before their first PunchOut connection.

 ###   Where do I get the PunchOut plugin for Vendure? +

 The plugin is called @vendure-community/punchout-gateway-plugin and is installed as an npm package. The source code is in the vendurehq/community-plugins repository on GitHub, licensed under GPL-3.0-or-later. The plugin is free of charge and requires an active PunchCommerce account.

###   What are the requirements for my Vendure shop? +

 You need Vendure 3.0 or later and a storefront you can modify. Because Vendure is headless, a PunchOut landing page, a cart bound to the PunchOut session and a button that transfers the cart belong in your storefront.

###   Which PunchOut protocols does the Vendure plugin support? +

 The plugin connects your shop to the PunchCommerce gateway, and the gateway speaks OCI, cXML and [IDS Connect](https://www.punchcommerce.de/en/ids-connect). You set the protocol per customer in PunchCommerce. The plugin itself only exchanges JSON over HTTPS with PunchCommerce; PunchCommerce handles the communication with your customer's system.

###   How does the shop know which customer is buying? +

 The plugin adds the field “PunchOut Customer ID (uID)” to customers in Vendure. There you enter the same value you use in PunchCommerce as the customer identifier. On entry, PunchCommerce appends the parameters sID and uID to your entry address; your landing page uses them to log the buyer in via the authenticate mutation.

###   What do I check if the entry or the cart transfer does not work? +

 If the login fails, first check whether the uID matches the customer identifier in PunchCommerce. If the cart stays empty, an order operation is missing activeOrderInput with the session ID. If a second transfer fails, that is expected: only one transfer is possible per session. If parallel sessions overwrite each other, the sID belongs in sessionStorage instead of a cookie. If the shop does not load in the procurement system's iFrame, set the session cookies to SameSite=None; Secure and remove the X-Frame-Options header during the PunchOut session. Make sure your shop remains protected against clickjacking, so that third-party pages cannot embed it unnoticed.

###   What happens to my PunchOut customers if I switch shop systems? +

 Nothing that affects your customers. Credentials, protocol, field mapping and the address their procurement system calls live in the PunchCommerce gateway, not in the shop. You install the plugin in the new shop, change the entry URL per customer and test with the simulator. How this works step by step is shown on the page [Replatforming with the gateway](https://www.punchcommerce.de/en/punchout-gateway-replatforming).

###   What does PunchOut for Vendure cost? +

 The plugin is open source and free of charge. PunchCommerce Business costs €49 per connected customer per month, plus VAT. Three customers therefore cost €147 per month, plus VAT. If you need an SLA and operational responsibility, PunchCommerce Enterprise is the right plan.

  Get started

 Your customer is waiting for PunchOut. Deliver it from your Vendure shop.
---------------------------------------------------------------------------

 €49 per customer per month, plus VAT. Install the plugin, adapt the storefront, create the customer, send the access details, done.

 [ Start free trial ](https://www.punchcommerce.de/register)30 days free · no credit card · cancel anytime

 ![Patrick Dornbusch, founder of PunchCommerce](https://www.punchcommerce.de/static/patrick-dornbusch.webp)Patrick Dornbusch

Founder of PunchCommerce

Prefer to talk first? In 30 minutes we’ll work out which option suits your shop, your ERP and your customers’ procurement systems.

 [ Schedule a consultation  (opens in a new window) ](https://account.netzdirektion.de/appointments/punchcommerce)30 min · remote · with the founder

 PunchCommerce® is a product of [ ![netzdirektion | Gesellschaft für digitale Wertarbeit mbH](https://www.punchcommerce.de/static/netzdirektion-logo.png) (opens in a new window) ](https://netzdirektion.de) ![DEKRA seal: quality management according to ISO 9001](https://www.punchcommerce.de/static/dekra-netzdirektion-iso-9001.png) **ISO 9001:2015**
certified quality management

 netzdirektion | Gesellschaft für digitale Wertarbeit mbH · © 2020 - 2026
