Subscriptions API (v2 - DEPRECATED)
VTEX Subscriptions REST API Documentation This documentation describes the available REST APIs for VTEX Subscription System. With Subscriptions you can set up…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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)
Endpoints 31
Subscriptions
- GETRetrieve customer's subscriptions
/subscriptions?customerId=user@vtex.com.brRetrieves details of a given customer's subscriptions, searching by that customer's customerId. - GETGet Subscription List
/subscriptions/listRetrieves a list of Subscriptions linked to your store. - GETRetrieve subscription by ID
/subscriptions/:subscriptionIdLists Subscription's details, searching by subscriptionId. - PATCHUpdate Subscriptions by SubscriptionId
/subscriptions/:subscriptionIdUpdate, add or alter information of a given Subscription, filtering by subscriptionId. - POSTInsert Addresses for Subscription
/subscriptions/:subscriptionId/addressesInserts address's information to complement the Subscription details. - PATCHCancel Subscriptions by SubscriptionId
/subscriptions/:subscriptionId/cancelCancels all Subscriptions of a subscription group. This operation does not have a rollback. Once cancelled, it cannot be re-activated - GETGet frequency options by subscriptionId
/subscriptions/:subscriptionId/frequency-optionsLists frequency options for the Subscription, filtering by subscriptionId.
Subscription Group
- GETList All subscription groups
/subscriptions-groupRetrieves all subscription groups in your store. - GETGet subscription group list
/subscriptions-group/listRetrieves a list of Subscription groups in your store. - GETGet Next purchase
/subscriptions-group/nextPurchase/:dateStrLists details of a given subscription group's next purchase, filtering by dateStr. - GETGet Simulation by subscription-group
/subscriptions-group/simulate/:groupIdRetrieves Subscription simulations, filtering by groupId. - GETGet Subscription by groupId
/subscriptions-group/:groupIdLists Subscription details, filtering by groupId. - PATCHUpdate Subscription by groupId
/subscriptions-group/:groupIdUpdates a Subscription by groupId. - POSTAdd Subscription item by groupId
/subscriptions-group/:groupId/additemAdds an SKU to a given Subscription, filtering by groupId. - GETGet addresses by groupId
/subscriptions-group/:groupId/addressesLists addresses linked to a given Subscription group, filtering by groupId. - POSTInsert Addresses by groupId
/subscriptions-group/:groupId/addressesInsert address information of a given Subscription group, filtering by groupId. - PATCHCancel Subscription by groupId
/subscriptions-group/:groupId/cancelCancels Subscription by groupId - GETList Subscription group's Configuration
/subscriptions-group/:groupId/configRetrieves details about a given subscription group's configuration, filtering by groupId. - GETGet Conversation Message by groupId
/subscriptions-group/:groupId/conversation-messageRetrieves the conversation of a given Subscription group, filtering by groupId. - GETGet frequency options by groupId
/subscriptions-group/:groupId/frequency-optionsLists frequency options of a given Subscription group, filtering by groupId. - GETGet payment System by groupId
/subscriptions-group/:groupId/payment-systemsRetrieves payment system's information of a given Subscription group, filtering by groupId. - GETList 'Will create' by groupId
/subscriptions-group/:groupId/will-createRetrieves Subscription groups listed as 'will create', filtering by groupId. - POSTRetry subscription by groupId
/subscriptions-group/:groupid/instances/:instanceId/retryPermits the retry of a Subscription group, via API, filtering by groupId and instanceId.
Report
- GETGet report status by ID
/report/reportStatus/:reportIdRetrieves the Subscription's report status, filtering by its reportId. - GETRetrieve Subscription report by date
/report/subscriptionsByDate?requesterEmail=user@vtex.com.br&beginDate=20190101&endDate=20190701Retrieves a report with the subscriptions created at the date interval requested - GETRetrieve Subscription report by Status
/report/subscriptionsByStatus?requesterEmail=user@vtex.com.br&status=1Retrieves Subscriptions' reports, filtering by status. The report will be sent by email, to the address inserted in the API's path. - GETRetrieve Subscription report by order date
/report/subscriptionsOrderByDate?requesterEmail=user@vtex.com.br&beginDate=20190101&endDate=20190701Retrieves a report regarding the Subscriptions created during the date interval of orders. - GETRetrieve Subscription report by schedule
/report/subscriptionsScheduled?requesterEmail=user@vtex.com.br&beginDate=20190101&endDate=20190701Retrieves a report regarding the Subscriptions scheduled to execute at the date interval requested - GETRequest report by update
/report/subscriptionsUpdated?requesterEmail=user@vtex.com.br&beginDate=20190101&endDate=20190701Retrieves a report regarding Subscriptions updated in the date interval chosen. The report will be sent by email, to the address inserted in the API's path.
Settings
- GETGet Subscriptions Settings
/settingsLists the current Subscriptions settings in your store. - POSTEdit Subscriptions settings
/settingsEdits Subscriptions settings in your store.
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br/api/rns- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 31 operations on 27 pathsGET 22POST 5PATCH 4
- Main resources
- Subscription Group 16Subscriptions 7Report 6Settings 2
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Subscriptions API (v2 - DEPRECATED) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Subscriptions API (v2 - DEPRECATED) collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve customer's subscriptions” (GET /subscriptions?customerId=user@vtex.com.br), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Subscriptions API (v2 - DEPRECATED)?
VTEX Subscriptions REST API Documentation This documentation describes the available REST APIs for VTEX Subscription System. With Subscriptions you can set up… It is listed under Other and has 31 endpoints.
Who publishes the Subscriptions API (v2 - DEPRECATED)?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Subscriptions API (v2 - DEPRECATED)?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br/api/rns. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Subscriptions API (v2 - DEPRECATED)?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the Subscriptions API (v2 - DEPRECATED) have?
31 operations on 27 paths (22 GET, 5 POST, 4 PATCH). The largest groups are Subscription Group, Subscriptions, Report, Settings.
Is forking the Subscriptions API (v2 - DEPRECATED) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.