Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Documented here.

  • Vendors can obtain the applicable customer support categories (category key), subcategories (subcategory key) and subcategories IDs (subcategoryId key) from our content management system . You can find how in the reference doc [add link].(Sanity).

  • Use the following Sanity endpoint to get:

    • categories names and Sanity IDs

    , names and referenced subcategories:
    • .

    • subcategories names, Sanity IDs and KnowledgeForce Issue IDs.

Code Block
https://czqk28jt.api.sanity.io/v2021-10-21/data/query/

...

prod_bk_pt?query=*

...

%5B_type+%3D%3D+%22supportCategoryGroup%22%5D+%7B%0A++_

...

id%2C%0A++name%2C%0A++%22subcategories%22%3A+supportSubcategories%5B%5D-%3E%7Bname%2C_id%2CknowledgeForceIssueId%0A%7D%0A%7D

Example for Burger King Portugal prod: https://czqk28jt.api.sanity.io/v2021-10-21/data/query/prod_bk_pt?query=*[_type+%3D%3D+

...

"supportCategoryGroup"]

...

Sanity endpoint to get subcategories IDs [are vendors supposed to use the Sanity subcategory ID or the Knoweldge Force ID] and names:

Code Block
https://czqk28jt.api.sanity.io/v2021-10-21/data/query/[environment]_[brand]_[country]?query=*%5B%0A++_type%3D%3D%22supportSubcategory%22%0A%5D%0A%7B_id%2Cname%2CknowledgeForceIssueId%7D

...

+{ ++_id%2C ++name%2C ++"subcategories"%3A+supportSubcategories[]->{name%2C_id%2CknowledgeForceIssueId } }

Extract:

Code Block
{
      "_id": "79aa6e88-e870-497c-9be5-4fe0f2e96eb9",
      "name": {
        "pt": "Entrega ao domicĂ­lio ",
        "_type": "localeString",
        "en": "Home Delivery",
        "es": "Pedido a domicilio"
      },
      "subcategories": [
        {
          "name": {
            "pt": "Tempo de entrega em casa",
            "_type": "localeString",
            "en": "Delivery Time",
            "es": "Tiempo de Entrega a Domicilio"
          },
          "_id": "621be5e3-0bb6-4912-948a-351eead441ba",
          "knowledgeForceIssueId": "0201"
        },