Faq

You can define a set of questions and answers that is linked to some context, for instance, checkout page. This set of questions inside of some context is our FAQ.

There are some global faqs that exists by default on all of our tenants/companies, but all companies can create its own faq itens inside pre-existing context or event create a completely new context and its own faq items.

FAQ items entities are I18n compliant.

FAQ Model (Example)
{
  "id": "e9aa37cd-0d43-425e-828a-1fda093cbdf1",
  "createdAt": "2022-09-15T14:19:47.052Z",
  "updatedAt": "2022-09-15T14:19:47.052Z",
  "context": {
    "id": "e9aa37cd-0d43-425e-828a-1fda093cbdf2",
    "createdAt": "2022-09-15T14:19:47.052Z",
    "updatedAt": "2022-09-15T14:19:47.052Z",
    "name": "pre-sale"
  }
  "question": {
    "pt-br": "Como comprar?",
    "en": "How to purchase?"
  },
  "answer": {
    "pt-br": "Basta colocar o cartao de credito e pagar que adicionamos a sua wallet.",
    "en": "You can put your items into your cart, click on purchase and pay with your credit card."
  },
  "externalUrl": "https://w3block.io/faqitem"
}

Service Methods

Listing FAQ context items

Using SDK
// init your sdk as defined in main page of Commerce service
import { W3blockCommerceSDK } from '@w3block/sdk-commerce';
const sdk: W3blockCommerceSDK;
...

const tenantId = '<your tenant id>';
const faqItems = await sdk.api.companies.listFaq(tenantId, { page: 1, limit: 10, name: 'pre-sale' });
console.log('faqItems', faqItems);

Rest API reference:

PreviousWebhooksNextGlobals

Last updated