Connect VTEX to Pipe17

VTEX is an Enterprise Digital Commerce Platform.

Pipe17 supports the following data flows for the VTEX Connector:

• Pull Orders from VTEX
• Pull Products from VTEX
• Push Products to VTEX
• Pull Inventory from VTEX
• Push Inventory to VTEX
• Push Fulfillment to VTEX
• Pull Fulfillment to VTEX
• Pull Locations from VTEX

In this article

• Requirements
• Connecting VTEX to Pipe17
• Connection Flow Settings
• What's Next?

Requirements

• Pipe17 Account - Ensure that you have a Pipe17 account. If you do not yet have a Pipe17 account, book a demo with a Pipe17 team member to get started.
• Ensure you have access to your VTEX admin account. This will be needed to establish connection to Pipe17/VTEX account.

Connecting VTEX to Pipe17

1. Navigate to the Integrations tab in your Pipe17 portal and click on "Add Integration" in the upper right corner.
2. Find the VTEX Connector and Click on Add.
3. The Connection Flow Settings page is displayed, leave these toggles turned off for now. We will revisit these later in the guide.
4. Click Next
5. Shop URL: Fill in your Shop URL. On VTEX click on the Visit Store link on the top right and copy the URL it takes you to.
6. Application Key & Application Token:

   1. Navigate to the Application Keys page (e.g. https://shopname.myvtex.com/admin/mykeys) 

      Click on the Account name on the top right corner > Account Settings > Application Keys > Click on Generate New. 

      • Add a Label

      • Add Role (Admin Owner role should be available by default)

      • Click on Generate. At this time it will also show Access Token (not visible later).

7. Click Connect.

Connection Flow Settings

• Orders: Set to either Pull Orders from VTEX or Disabled.
  
  • Pull orders from VTEX:  pulls in all Orders from VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
• Products: Set to either Pull from VTEX, Push to VTEX, or Disabled.
  • Disabled: Select this option to neither pull nor push products from/to VTEX
  • Pull products from VTEX to Pipe17: pulls in the Product Catalog from VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
  • Push products from Pipe17 to VTEX: pushes Product Catalog updates into VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
• Inventory: Set to either Pull from VTEX, Push to VTEX, or Disabled.
  • Disabled: Select this option to disable inventory pulls and pushes to/from VTEX.
  • Pull inventory changes to VTEX: pulls in Inventory from VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
  • Push inventory changes to VTEX: pushes Inventory updates into VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
• Fulfillments: Set to Pull from VTEX, Push to VTEX, both Push & Pull or Disabled.
  • Disabled: Select this option to disable fulfillment pulls and pushes to/from VTEX.
    
  • Pull fullfillments changes to VTEX: pulls in Fulfillments from VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
  • Push fulfillments to VTEX: pushes Fulfillments updates into VTEX starting from the datetime when the VTEX Integration was enabled on Pipe17.
  • Push & Pull fullfillments changes to VTEX: update Fulfillments in both directions into and out of VTEX  starting from the datetime when the VTEX Integration was enabled on Pipe17.
• Locations: Set to Pull from VTEX by default. This setting cannot be turned off since Order Processing depends on Location information.

What's Next?

Congrats! You've connected VTEX to your Pipe17 account, and you're now ready to begin testing! Check out our Pipe17 Quick Start Guide for some helpful context on testing and other subjects.