Skip to content

Store adapter — VTEX

The adapter object contains properties for connecting to the VTEX API.

Parent object: a store with property "platform" : "vtex"

Required properties

The following adapter properties are required for VTEX stores.

account_name

Propertyaccount_name
NameVTEX Account Name
Data typestring
Required?Yes

app_key

Propertyapp_key
NameVTEX Application Key
Data typestring
Required?Yes

app_token

Propertyapp_token
NameVTEX Application Token
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for VTEX stores.

product_identifier

Propertyproduct_identifier
NameProduct Identifier
Data typestring
Accepted values
  • "refId"
  • "ean"
  • "id"
  • "productId"
Default"refId"

warehouse_name

Propertywarehouse_name
NameInventory Warehouse Name
Data typestring

Example

Example: create a new VTEX store
curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your VTEX Store",
  "platform": "vtex",
  "adapter": {
    "account_name": "abc123",
    "app_key": "abc123",
    "app_token": "abc123",
    "warehouse_name": "abc123",
    "product_identifier": "refId"
  }
}
EOF

For details about this request type, see: Create a new store.