vtex.local

VTEX Subscriptions REST API Documentation This documentation describes the available REST APIs for VTEX Subscription System. With Subscriptions you can set up regularly scheduled deliveries. All requests need authorization (VTEX Id authentication token or VTEX Appkey and Apptoken headers)

🔑 apikey 31 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Get Subscriptions Settings

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/settings

Retrieve customer's subscriptions

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/subscriptions

Get Subscription List

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/subscriptions/list

Endpoints (31 total)

GET

/settings

Get Subscriptions Settings

GET

/subscriptions

Retrieve customer's subscriptions

GET

/subscriptions/list

Get Subscription List

GET

/subscriptions-group

List All subscription groups

GET

/subscriptions-group/list

Get subscription group list

GET

/report/subscriptionsByDate

Retrieve Subscription report by date

GET

/report/subscriptionsUpdated

Request report by update

GET

/report/subscriptionsByStatus

Retrieve Subscription report by Status

GET

/report/subscriptionsScheduled

Retrieve Subscription report by schedule

GET

/subscriptions-group/{groupId}

Get Subscription by groupId

GET

/report/reportStatus/{reportId}

Get report status by ID

GET

/subscriptions/{subscriptionId}

Retrieve subscription by ID