Connect a system
These guides connect the platform to the systems a B2B business already runs: an ERP, a PIM, a CRM, or a supplier's catalog feed. Each guide says which route it takes: the BMECAT import is walked twice, once over the API so you can run it from your own code and once as an Integration Studio workflow that runs on a schedule without middleware of your own. Punchout is API-only, and the ERP hand-off is a workflow for the way out with API calls for the way back. Receiving events is the one route that runs on a server of your own: a webhook endpoint you host, with a reconcile job over the API.
Integration Studio is experimental and its schemas are drafts. The pages linked here are current, not final.
Before you start
- A tenant, and an API key with the scopes the guide names. See API keys, create an API key and which scope covers which app.
- For the workflow half: Integration Studio enabled on the tenant and permission to open it in Cockpit. Nothing is installed locally.
- Credentials for the system you connect, once you go beyond a first test run.
First step
For the workflow route, open Integration Studio → Workflows → New in Cockpit, or start with Integration Studio: getting started to build a first workflow, run it by hand and put it on a schedule. For the API route, start with the guide below.
The guides
- Import a BMECAT catalog — turn a supplier's BMECAT feed into products with an import profile, a signed upload and a profile run, then put it on a schedule with the official template.
- Connect a procurement system by punchout — let a buyer shop your storefront from inside SAP, Ariba or Coupa over OCI or cXML, and send the cart back to their system.
- Hand an order to the ERP — book every placed order in the ERP with a workflow, write the ERP's id back onto the order, and report holds, shipments, stock and payments back from the ERP side.
- Receive platform events at your own endpoint — register a webhook in Cockpit, answer inside the delivery contract, dedupe on the event id and close the gaps an outage leaves by re-reading the API.
- Send low-stock alerts to the ERP — turn a row running low into a requisition in the ERP with a workflow, choose whether the platform or the ERP raises reorders, and book the delivery back in without counting it twice.
- Recover abandoned carts with a workflow — react to a cart the platform marked abandoned, send a reminder through your own mail or CRM, reopen the cart when the buyer returns, and set the retention windows so the cart is still there.
- Keep an Integration Studio workflow running — make a scheduled workflow safe to run twice, read a failed night, choose between retry, resume and replay, catch up a missed firing and roll back a bad save.
Reference
- Choose which system owns each entity — decide the master, the join key and the import mode for each entity before you build a feed.
- Choose an event surface — reacting to platform events: a webhook, a workflow trigger or an App handler.
- Import and export — the
/v1/ioAPI behind every bulk feed. - Reaching Revenue Cloud — the ways a workflow calls the platform.