Work with Smart Menu Configuration

For UX to be accessible, menu items require in-built help text.

These menu items lead to a subset of product offerings that are filtered by the product offering filter criteria. Only the tenant back office specialist can create or update the menu configurations for the given channel.

  • To get the menu configuration details for a channel, run the following cURL command or use a REST API client:
    curl -H Authorization: Bearer <accessToken> https://<hostName>/cx/industry/buying/configManagement/v1/menuConfig/{channel_id} -X GET
  • To get specific menu configuration for given channel, run the following cURL command or use a REST API client:
    curl -H Authorization: Bearer <accessToken> https://<hostName>/cx/industry/buying/configManagement/v1/menuConfig/{channel_id}/{menu_id}? -X GET

Insert Menu Configuration

Here's how you can insert or update the menu configuration:
  1. Create a payload for specifying the menu configuration with details described in the table:

    Menu Configuration Details

    Field Description
    channelId Channel id
    name Channel name
    description Description
    menu Array of menu objects.
    id menu id
    name menu name
    description Menu description
    order order sequence number
    startDate Start date
    endDate End date
    displayInfo Object has attributes with display text.
    name name
    description description
    locale List of objects.
    key Locale key
    value object
    name Name
    description Description
    facet Facet object
    id facet id
    queryFilter Query filter object
    key filter key
    value value
  2. Call the configuration API by running this cURL command or by using a REST API client:
  3. curl -H Authorization: Bearer <accessToken> https://<hostName>/cx/industry/buying/configManagement/v1/menuConfig -X POST -H "Content-Type: application/json" -d @sc-data.json
    where
    • <accessToken> is the OAuth access token for Back Office Specialist role.
    • <hostName> is the URL for the CX Industries Framework API Gateway.