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 PackageBee

  1. In your PackageBee Dashboard, click Stores.

In the PackageBee Dashboard, click Stores.

  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. Enter the Inventory Warehouse Name, corresponding to the name listed at VTEX Home > Inventory & Shipping > Dashboard > Warehouses.
  2. Optional: Specify the Product Identifier, one of:
  • refId (the default)
  • ean (required for Catalog v2 support)
  • id
  • productId
  1. Optional: To enable Catalog v2 support, check the box Use Catalog v2 for Inventory Update.

VTEX connection details - additional

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

  1. 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.