VTEX - Enable API Access

Karl Falconer · Updated

This article is for whoever connects a VTEX account inside DropStream — a fulfillment provider (3PL) or a merchant who manages their own DropStream account. You’ll add the store through DropStream’s Add Connection wizard. If a fulfillment provider is setting up DropStream for you, you don’t need this page — just gather your VTEX API credentials and send them over.

What you’ll need

How DropStream connects to VTEX

Every store connects through the same Add Connection wizard. For the full walkthrough of the wizard’s four steps, see Add a Connection. This article covers only the Store Setup step, where you enter the VTEX-specific details.

Enter your VTEX details

  1. In the Add Connection wizard, work through to the Store Setup step. Choose Create new store, give the store a Name, and select VTEX as the Platform. The VTEX credential fields appear below.

  2. Enter your credentials:

    Field What it is Example
    Account Name Your VTEX account name myaccount
    Application Token Your VTEX application token xxxxxxxx
    Application Key Your VTEX application key xxxxxxxx

    For where to find each value, see Get Your API Credentials.

  3. (Optional) Adjust the import settings:

    • Warehouse — select the VTEX warehouse (VTEX Home > Inventory & Shipping > Warehouses).
    • Use Catalog v2 for Inventory Update — when enabled, VTEX Catalog API v2 is used for inventory updates and the Product Identifier is forced to ean (default: disabled).
    • Product Identifier — one of refId (default), ean, id, or productId.
  4. Click Add connection.

Notes

  • When the connection is enabled, DropStream imports VTEX orders with status Ready for Handling.
  • If Catalog v2 is enabled, the Product Identifier is automatically set to ean.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.