VTEX - Enable API Access

The Application Programming Interface (API) allows for automated communication between connected systems. In order to automate fulfillment, API access must be enabled.

If you have not yet gathered your API credentials, follow these steps first:

Gather API credentials from VTEX.

Enter API credentials in DropStream

  1. In your DropStream Dashboard, click Stores.

In the DropStream Dashboard, click Store.

  1. Click the name of your VTEX store.
  2. In Connection details, enter your API credentials:
  • Account Name
  • Application Token
  • Application Key

VTEX connection details

  1. After the credentials have been entered, select the Warehouse from the dropdown menu (corresponding to the name listed at VTEX Home > Inventory & Shipping > Dashboard > Warehouses.)
  2. Optional: Edit any of the following settings:
  • Use Catalog v2 for Inventory Update — If enabled, VTEX Catalog API version 2 is used for inventory updates, and the Product Identifier is set to ean. (default: disabled)
  • Product Identifier — one of:
    • refId (the default)
    • ean (required for Catalog v2 inventory updates)
    • id
    • productId

VTEX connection details - additional

Note: If Catalog v2 is enabled, the Product Identifier for the store will be automatically set to ean.

  1. When you're done, click Save changes.


Order Import Status

When your connection is enabled, DropStream imports orders from VTEX that have the following order status:

  • Ready for Handling

Back to: Integration Overview

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request



Please sign in to leave a comment.