Description
Magento 2 Punchout Gateway is a Magento 2 extension that connects your store to e-procurement systems like SAP Ariba using the cXML format.
Inside SAP Ariba, buyers open your catalog, search for products, and fill a cart. The cart data goes back to Ariba as a purchase request.
Once the buyer submits the cart, Ariba sends a cXML purchase order to Magento. Magento places the order and returns a confirmation.
Payment method, shipping method, and order status are admin choices. Orders can go to a guest, one chosen customer, or a new customer account.
Stock stays locked for the days you set. Every request and response can be logged for later checks.
Additionally, if you want to set price rules for B2B customers by product, category, or quantity, then check Magento 2 Pricelist.
Highlighted Features of Magento 2 Punchout Gateway
cXML Support
Send and receive purchase data with SAP Ariba in the cXML format that e-procurement systems expect.
Punchout Catalog Access
Buyers open your Magento catalog from inside the e-procurement system and search products there.
Cart to Order Flow
Carts submitted in Ariba create Magento orders, and Magento sends a confirmation back.
Customer Handling Options
Order under a guest account, one chosen customer, or a newly created customer.
Stock Reservation
Lock ordered quantity for set days after cart transfer. Unordered stock returns to inventory.
Invoice Export
Send the invoice of a punchout order to the buyer's SAP Ariba account through an invoice endpoint.
Transaction Logs
Each setup, cart, order, and invoice request and response is reviewable in one admin grid.
Punchout Order View
See every punchout cart and order in admin, open cart items, and delete unplaced orders.
Why Do We Need Magento 2 Punchout Gateway?
Magento 2 Punchout Gateway exists because Magento 2 has no built-in link to e-procurement systems. Buyers inside SAP Ariba cannot reach your store.
Without a gateway, buyers copy product details into a requisition by hand. Staff then retype each purchase order into Magento, which risks errors.
Magento 2 Punchout Gateway removes both steps. The buyer shops your catalog from Ariba, and the submitted purchase order becomes a Magento order.
Setting up the Ariba catalog takes two URLs: postRequest for the punchout setup and postRequestOrder for the cXML order details.
Also, if you want buyers to negotiate prices before they order, you can check our extension Magento 2 Quote Extension.
Magento 2 Punchout Gateway Use Cases
-
Enterprise Buyers on SAP Ariba
A company buyer opens your store from SAP Ariba, fills a cart, and submits it for approval.
-
Suppliers Serving Many Buyers
A supplier connects with several buyers through one standard gateway instead of building each link.
-
Orders Without Buyer Accounts
A procurement team orders under a guest account or one assigned customer, with no new accounts.
-
Customer Group Pricing for Buyers
Product prices follow the customer groups set in Magento, so group discounts reach punchout buyers.
-
Stock Protection for Pending Carts
A store holds stock for a transferred cart and releases it when no order arrives in time.
-
Order Checks for Finance Teams
Admins review punchout orders, cart items, and invoice export results from the admin grids.
Install Magento 2 Punchout Gateway
Magento 2 Punchout Gateway installs by uploading the extension folder into the Magento root and running two commands.
- Upload the app folder from the package into the Magento root folder.
- Confirm the WkPunchOut folder sits at app/code/Webkul/WkPunchOut.
- Run php bin/magento setup:upgrade in the Magento root directory.
- Run php bin/magento c:c to clear the cache.
- Validate the licence key in the Punchout Configuration to show the other settings.
Punchout Catalog Endpoint Setup in SAP Ariba
The Catalogs page in SAP Ariba holds the punchout site. Admins create the site first, then set the Magento endpoints in the PunchOut Configuration.
- Set the postRequest endpoint for the punchout setup request.
- Set the postRequestOrder endpoint for the cXML order details.
- Use the pub/rest/default/V1/wk_punchout path on your Magento instance.
- Check the file status: Validated for a valid file, Activated once live.
- Create, test, view, edit, or delete the site from the Catalogs page.
Test the Punchout Site with a Simulated Product
After the site is created, admins test it in SAP Ariba before buyers use it. The test screen opens the Magento store inside Ariba.
- Choose the Credential Set for the site.
- Select the Ariba version you use: Buyer 7.0, 8.0, 8.1, 8.2.x, or Procure-to-Pay.
- Click Shop to open the Magento store in Ariba.
- Search products and add them to the cart as a buyer would.
Cart Transfer and Order Placement from SAP Ariba
The buyer fills the Magento cart and clicks Place Order. The cart data then moves to the Submit Cart step in SAP Ariba.
- Review items, quantity, unit price, and total in the Ariba Submit Cart step.
- Use Delete, Edit, or Inspect on a cart line before submitting.
- Click Submit Cart to send a cXML purchase order to Magento.
- Magento places the order and sends a confirmation back to Ariba.
- Product ID, name, price, currency, quantity, and UNSPSC attribute go with the cart.
Punchout Gateway General Configuration
General Configuration holds the base settings for punchout orders. The Reset Config button restores the default values.
- Validate the Licence Key to show the remaining settings.
- Pick the Punchout Gateway Store view.
- Set Order As Guest User, Create New User, or Select Customer for the order owner.
- Choose the Payment Method and Shipping Method for punchout orders.
- Choose the Order Status given to new punchout orders.
Message Header and Order Message Settings
Message Header Settings carry the sender and receiver details Ariba needs. Order Message Settings set how items are classified in the order message.
- Fill From Domain, From Identity, To Domain, and To Identity.
- Fill Sender Domain, Sender Identity, and Sender User Agent.
- Pick the Classification Domain: UNSPSC, NIGP, SKU, or ID.
- Enter a Default Classification Code, such as an UNSPSC code.
- Set Use Default Classification, for example Apply default only when missing.
Custom Log and Stock Release Settings
Custom Log Settings decide which data Magento stores in the custom log. They also set how long stock stays locked for a transferred cart.
- Log the Initial Request, its response, and the Order Response with Yes or No.
- Log the order cXML received from punchout and the one sent from Magento.
- Set Days to Clear Stock Quantity for the stock lock period.
- Turn Transaction Log on to keep records in the database.
- Set Days to Delete Log From DB to remove old logs.
- Add the webkul:clearstockquantity and webkul:deletetransactionlog cron commands.
Invoice Export Settings for Punchout Orders
Invoice Setting sends the invoice of a punchout order to the buyer's SAP Ariba platform. The invoice endpoint must be filled in first.
- Select Yes in Export Invoice to turn the feature on.
- Enter the invoice endpoint URL for punchout orders in Endpoint.
- Use the Ariba cXML transaction service URL given by your Ariba account.
- Check the Invoice Requisition and Invoice Response rows in the Transaction Log.
Punchout Orders, Cart View, and Transaction Log
The eShopSync Punchout Gateway menu lists every punchout order and log record. Admins track order status and find failed requests from these grids.
- Punchout Orders shows Cart ID, Order ID, Punchout Order ID, Order Status, and Order Placed By.
- Open View Cart to see Product ID, image, name, SKU, price, quantity, and cart total.
- Delete punchout orders that show Order not placed yet.
- Transaction Log lists Setup, Cart Transfer, Order Create, and Invoice requests and responses.
- Click Show Message to read a record and see the error text when a request fails.
Punchout Gateway for Magento 2 - Support
For any query or issue please create a support ticket here http://webkul.uvdesk.com