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. Select the VTEX tile.

    tile_VTEX.png
  3. Enter the URL of your VTEX account, your API Key, and API Token.

    setupVTEX_PU.png
  4. 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:

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