vtex.local – Subscriptions-API-(v2)

Tools (33)

Extracted live via the executor SDK.

• report.getreportstatusbyId

  Retrieves the Subscription's report status, filtering by its reportId.

• report.requestreportbydate

  Retrieves a report with the subscriptions created at the date interval requested

• report.requestreportbyorderdate

  Retrieves a report regarding the Subscriptions created during the date interval of orders.

• report.requestreportbyschedule

  Retrieves a report regarding the Subscriptions scheduled to execute at the date interval requested

• report.requestreportbyStatus

  Retrieves Subscriptions' reports, filtering by status. The report will be sent by email, to the address inserted in the API's path.

• report.requestreportbyupdate

  Retrieves 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.editSettings

  Edits Subscriptions settings in your store.

• settings.getSettings

  Lists the current Subscriptions settings in your store.

• subscriptionGroup.additemsubscriptionGroupId

  Adds an SKU to a given Subscription, filtering by groupId.

• subscriptionGroup.cancelSubscriptionbygroupId

  Cancels Subscription by groupId

• subscriptionGroup.getaddressesbygroupId

  Lists addresses linked to a given Subscription group, filtering by groupId.

• subscriptionGroup.getAllsubscriptiongroup

  Retrieves all subscription groups in your store.

• subscriptionGroup.getConfigsubscriptionsgroup

  Retrieves details about a given subscription group's configuration, filtering by groupId.

• subscriptionGroup.getConversationMessagebygroupId

  Retrieves the conversation of a given Subscription group, filtering by groupId.

• subscriptionGroup.getfrequencyoptionsbygroupId

  Lists frequency options of a given Subscription group, filtering by groupId.

• subscriptionGroup.getNextpurchase

  Lists details of a given subscription group's next purchase, filtering by dateStr.

• subscriptionGroup.getpaymentSystembygroupId

  Retrieves payment system's information of a given Subscription group, filtering by groupId.

• subscriptionGroup.getSimulatebysubscriptionGroup

  Retrieves Subscription simulations, filtering by groupId.

• subscriptionGroup.getSubscriptionbygroupId

  Lists Subscription details, filtering by groupId.

• subscriptionGroup.getsubscriptiongrouplist

  Retrieves a list of Subscription groups in your store.

• subscriptionGroup.getwillcreatebygroupId

  Retrieves Subscription groups listed as 'will create', filtering by groupId.

• subscriptionGroup.insertAddressesbygroupId

  Insert address information of a given Subscription group, filtering by groupId.

• subscriptionGroup.retrysubscriptionbygroupId

  Permits the retry of a Subscription group, via API, filtering by groupId and instanceId.

• subscriptionGroup.updateSubscriptionbygroupId

  Updates a Subscription by groupId.

• subscriptions.cancelSubscriptionsbySubscriptionId

  Cancels all Subscriptions of a subscription group. This operation does not have a rollback. Once cancelled, it cannot be re-activated

• subscriptions.getfrequencyoptionsbysubscriptionId

  Lists frequency options for the Subscription, filtering by subscriptionId.

• subscriptions.getsubscriptionbyId

  Lists Subscription's details, searching by subscriptionId.

• subscriptions.getSubscriptionList

  Retrieves a list of Subscriptions linked to your store.

• subscriptions.getsubscriptionstocustomer

  Retrieves details of a given customer's subscriptions, searching by that customer's customerId.

• subscriptions.insertAddressesforSubscription

  Inserts address's information to complement the Subscription details.

• subscriptions.updateSubscriptionsbySubscriptionId

  Update, add or alter information of a given Subscription, filtering by subscriptionId.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools