Skip to main content

Centra - Back in stock

Prerequisites

Before starting the configuration, 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.

  • Engage Email Template: A "Back in Stock" module must be added to your Engage email templates.

  • API Credentials: Set up API credentials in Centra and Voyado Engage.

Configuration of API token in Centra

  1. Log in to Centra.

  2. Navigate to System > API Tokens.

  3. Create a new Integration name. (e.g. Voyado integration).

    Note

    Choosing an existing Integration name may cause conflicts with other integrations.

  4. Enable all Store types.

  5. Enable all Stores that you wish to integrate with Voyado.

  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

Note

The subscription flow is not supported “out of the box” and requires front-end development.

Note

Recommendation to Implement Captcha

To enhance security and prevent abuse of the Back-in-Stock Subscription API, we strongly recommend integrating a Captcha system. Since the API is open without authorization, it is vulnerable to automated scripts and fraudulent activities. Adding Captcha will help verify that requests originate from legitimate users and protect against bots manipulating the system, ensuring a secure and reliable user experience.

  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.

Note

Ensure that the locale field aligns with the locales associated with the product feeds in Engage.

Example: “en-US”

HTTP Method

POST

Base URL

 https://accelerator.voyado.com/

Endpoints

 v1/centra/back-in-stock/subscribe

Body JSON example

{
    "email": "john.doe@voyado.com",
    "sku": "1234-1",
    "acceptemail": true,
    "store": "voyado.centraqa",
    "locale": "en-US",
    "externalId":"4"
}

Output to Engage

Content creation

{
    "email": "john.doe@voyado.com",
    "acceptsEmail": true,
    "lang": "en",
    "countryCode":"US"
}

Subscription

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

Field definitions

Fields marked with (*) are mandatory.

Subscriptions

Field name

Type

Description

email*

string

The email address of the user. Must be a valid email format.

Example: "john-doe@voyado.com".

sku*

string

The productSize.SKU in Centra

Example: "1234-1"

acceptemail*

boolean

If user accepts general newsletters or not

store*

string

The store name in Centra

Test: voyado.centraqa

Production: voyado.centra

locale*

string

One of the locales connected to the product feeds in Engage.

Example: "sv-SE"

externalId*

string

The Market ID connected to the user. Must match the Market ID in the stock change.

Stock changes

Field name Engage

Field name Centra

Type

Description

sku*

productSize.SKU

string

The productSize.SKU in Centra.

Example: "1234-1"

quantity*

Free to allocate (FTA)

int

The FTA quantity of the product.

Example: 125

externalId*

Market ID

string

Market ID connected to the stock change.

Note: This value must match the Market ID in the subscriptions.

Workflow

workflow.png
In this section: