Skip to main content
Before starting the back in stock configuration for Centra, ensure the following:
  • Product Feeds: Product feeds must be connected to Voyado Engage for each locale (Ex: sv-SE).
  • Event System in Centra: The event system must be enabled in Centra. Contact your Centra Customer Success Manager for validation.
  • Back in Stock email module: A “Back in Stock” module must be added to your Engage email templates.
  • API Credentials: API credentials must be set up in Centra and Voyado Engage.

​
Configuration of API token in Centra

Follow these steps:
1

Log in to Centra

2

Navigate to System > API Tokens

3

Create a new Integration

The Integration should have a relevant name, for example “Engage integration”.
Choosing an existing name can cause conflicts with other integrations.
4

Enable all Store types

5

Enable all Stores you wish to integrate with Engage

6

Enable the following permissions

Write permissions:
  • Event
Read permissions:
  • Allocation rule
  • Market
  • Product
  • Product Size
  • Product Variant
  • Stock Change
  • Store
  • Warehouse
  • Orders
  • Returns
7

Save the API token securely

8

Share the API token securely with your Voyado team

​
Subscription API for Centra

The subscription flow is not supported “out of the box” and requires front-end development.
To enhance security and prevent abuse of the Back-in-Stock Subscription API, we strongly recommend using a Captcha system. Since the API is open and has no authorization, it is vulnerable to automated scripts and fraudulent activities. Adding a Captcha will help verify that requests originate from legitimate users and protect against bots manipulating the system, ensuring a secure and reliable user experience.
These are the steps in building a subscription flow:
  1. Build a subscription form that is visible when the end user enters a product variant page that is considered to be out-of-stock.
  2. Register the subscriptions in Voyado Engage, using the Subscription API for Centra.
  3. Ensure that the locale field aligns with the locales associated with the product feeds in Engage (for example: “en-US”).

​
HTTP Method

The subscription endpoint
POST https://accelerator.voyado.com/api/v1/centra/back-in-stock/subscribe

{
    "email": "john.doe@voyado.com",
    "sku": "1234-1",
    "acceptemail": true,
    "store": "voyado.centraqa",
    "locale": "en-US",
    "externalId":"4"
}
​
email
string
required
The email address of the user. Must be a valid email format. Example: “john-doe@voyado.com”
​
sku
string
required
The productSize.SKU value in Centra. Example: “1234SIZEM”
​
acceptemail
boolean
required
If user accepts general newsletters or not. Example: true
​
store
string
required
Unique identifier for your Centra environment. Example: “voyadotenant-1”
​
locale
string
required
Locale matching Engage product feeds. Example: “sv-SE”
​
externalId
string
required
The Market ID connected to the user. Must match the Market ID in the stock change. Example: “4”
{
    "email": "john.doe@voyado.com",
    "acceptsEmail": true,
    "lang": "en",
    "countryCode":"US"
}

{
    "ContactId": "0fbfa450-35a6-4d0b-bcd3-b22f00f1ee47",
    "sku": "1234-1",
    "locale": "en-US",
    "externalId":"4"
}

​
Store field format

The store field must be a unique string based on your client’s setup:
When you have a single Engage environment for all stores just use the tenantId value as the store field. For example: “mytenant”. When you have multiple Engage stores (one per Centra store) combine the tenantId and CentraStoreID to a single string. For example “mytenant-124”. This ensures each connection is uniquely identified in Engage. Stock changes Engage receives the current Free to Allocate (FTA) quantity for a product at the time of the stock change event. It does not calculate or use the delta (the change in quantity). This means the quantity value in the payload always reflects the latest available stock level, and not how much it changed since the last update.
Field name EngageField name CentraTypeDescriptionExample
sku*productSize.SKUstringThe productSize.SKU in Centra.”1234-1”
quantity*Free to allocate (FTA)intAvailable stock quantity.125
externalId*Market IDstringMarket ID matching subscription data.”4”

​
Workflow

The workflow as an image:
The back-in-stock workflow