1. ShipStation Help U.S.
  2. Integrations Help Guide
  3. Stores T-Z

VTEX

VTEX combines Commerce, Marketplace, and Order Management in a single platform to open new revenue streams.

VTEX Requirements

Connection Requirements:

  • An active account with VTEX.

  • Your VTEX account API Key and API Token

Order Import Requirements:

  • Must include a Ship To address.

Connect a VTEX Store to ShipStation

To connect your VTEX store to ShipStation:

  1. Create your API key and API token in your VTEX account.

  2. Open a new tab or browser window and log in to your ShipStation account.

  3. Go to Account Settings.

    Closeup of Toolbar. The red box highlights the icon for Settings.

  4. Select Selling Channels from the left-hand sidebar, then choose Store Setup.

    Left-hand sidebar. Under Selling Channels, red box highlights Store Setup

  5. Click + Connect a Store or Marketplace.

    Closeup of Store Setup. Red arrow points to Connect a Store or Marketplace button.

  6. Select the VTEX tile.

    tile_VTEX.png

  7. Enter the URL of your VTEX account, your API Key, and API Token.

    setupVTEX_PU.png

  8. Click the Connect button to finish.

After you've completed the connection steps, your store will be connected to ShipStation. You'll be taken to the store's Settings page to adjust the store-specific settings like branding, notification preferences, and product handling.

Available Features for the VTEX Integration

ShipStation's integration with VTEX supports the following standard features:

Key: Green checkmark. Supported feature. Yes. = Supported; Red X mark. Unsupported feature. No. = Not Supported; Grey dash icon. Not applicable. = Does Not Apply

Common Integration Features

Feature

Supported?

Custom Statuses

Red X mark. Unsupported feature. No.

Customer Emails

Green checkmark. Supported feature. Yes.

Customer Phone Numbers

Green checkmark. Supported feature. Yes.

Requested Service

Red X mark. Unsupported feature. No.

Payment Method

Red X mark. Unsupported feature. No.

Discounts

Red X mark. Unsupported feature. No.

Identifies Gift Orders

Red X mark. Unsupported feature. No.

Internal Notes

Red X mark. Unsupported feature. No.

Notes from Buyer

Red X mark. Unsupported feature. No.

Order Weight

Red X mark. Unsupported feature. No.

Item Weight

Red X mark. Unsupported feature. No.

Item Images

Red X mark. Unsupported feature. No.

Item Options

Red X mark. Unsupported feature. No.

Item Warehouse Location

Red X mark. Unsupported feature. No.

Marketplace to ShipStation Order Status Mapping:

ShipStation Status

MARKETPLACE Status

Awaiting Payment

payment-pending

Awaiting Shipment

handling, payment-approved, ready-for-handling, payment-approved

Shipped

invoiced

Cancelled

canceled

On Hold

n/a

Sent with Shipment Update

Field

Supported?

Status Update

Green checkmark. Supported feature. Yes.

Tracking Number

Green checkmark. Supported feature. Yes.

Carrier

Green checkmark. Supported feature. Yes.

Service

Red X mark. Unsupported feature. No.

Carrier Fee

Green checkmark. Supported feature. Yes.

Note to Buyer

Red X mark. Unsupported feature. No.

Item Information

Red X mark. Unsupported feature. No.

This integration allows you to define the Status Mappings for the store connection.

ShipStation will import the customer email address and can send customer shipment notification and delivery emails.

ShipStation will import the customer phone number.

ShipStation will import the shipping method chosen by the customer at time of checkout.

ShipStation will import the payment method used to pay for the order.

ShipStation will import discount and coupon information for the order.

ShipStation is able to determine if an order was placed as a gift.

ShipStation will import internal notes or order activity from the selling channel.

ShipStation will import notes left by the customer at time of checkout. Displayed as Customer notes in ShipStation's Legacy Layout.

ShipStation will import the total order weight from the selling channel.

ShipStation will import the weight for each line item in the order.

ShipStation will import an image URL for each line item in the order.

ShipStation will import item options (such as color or size) for each line item in the order.

ShipStation will import a product stock location for each line item in the order.

Status UpdateTracking NumberCarrierServiceCarrier Fee

The shipment update ShipStation sends to the selling channel will include any Notes to Buyer set on the order in ShipStation.

Item Information

This integration allows you to define the Status Mappings for the store connection.

ShipStation will import the customer email address and can send customer shipment notification and delivery emails.

ShipStation will import the customer phone number.

ShipStation will import the shipping method chosen by the customer at time of checkout.

ShipStation will import the payment method used to pay for the order.

ShipStation will import discount and coupon information for the order.

ShipStation is able to determine if an order was placed as a gift.

ShipStation will import internal notes or order activity from the selling channel.

ShipStation will import notes left by the customer at time of checkout. Displayed as Customer notes in ShipStation's Legacy Layout.

ShipStation will import the total order weight from the selling channel.

ShipStation will import the weight for each line item in the order.

ShipStation will import an image URL for each line item in the order.

ShipStation will import item options (such as color or size) for each line item in the order.

ShipStation will import a product stock location for each line item in the order.

Status UpdateTracking NumberCarrierServiceCarrier Fee

The shipment update ShipStation sends to the selling channel will include any Notes to Buyer set on the order in ShipStation.

Item Information

Didn't find what you were looking for?