GET API/V40/System/Settings/CMS?SessionToken={SessionToken}

Retrieve CMS settings

Request Information

URI Parameters

Name	Description	Type	Additional information
SessionToken	The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.	string	Required

Body Parameters

None.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
SessionToken	The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.	string
ResponsesIncluded	A list of response messages names contained in this composite message, for easy pre-parsing.	string
Responses	A list of response messages contained in this composite message.	Collection of Object GetCMSSettingsResponse
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "6_FyBD7-3IgKAAAAAAAAAAAAAAA.fb5pLO95YqkRdJME5MyBo1RMhOvnL8IpC-qKnbGvzj8",
  "responsesIncluded": "getCMSSettingsResponse",
  "responses": [
    {
      "getCMSSettingsResponse": {
        "content": {
          "allowSignIn": true,
          "allowLanguageSetting": true,
          "showCookieDisclaimer": true,
          "showTermsAndConditions": true,
          "showWelcomeScreen": true,
          "messagePollingInterval": 6,
          "allow2wayMessaging": 7,
          "mobileConfigurationSettings": null,
          "taxCalculationEnabled": true,
          "basePriceCalculationEnabled": true,
          "taxCalculationMethod": 10,
          "googleTagManagerId": "sample string 11",
          "showFooterLinks": true,
          "hideOrderComments": true,
          "showAdBanner": true,
          "orderConfirmationBanner": {
            "bannerCode": "sample string 1",
            "name": "sample string 2",
            "html": "sample string 3",
            "bannerActionType": "sample string 4",
            "actionParameter": "sample string 5",
            "hasImage": true,
            "imageSrc": "sample string 7",
            "imageAmazonSrc": "sample string 8",
            "backgroundColor": "sample string 9",
            "adTag": "sample string 10",
            "title": "sample string 11",
            "bannerType": "sample string 12",
            "bannerSourceType": "sample string 13",
            "showAdvertisingLabel": true,
            "actionUrlParameter": "sample string 15",
            "sectionType": "sample string 16",
            "outletCode": "sample string 17",
            "startDate": "2024-11-06T08:35:49.5837163+00:00",
            "endDate": "2024-11-06T08:35:49.5837163+00:00",
            "sectionCode": "484f0467-288b-44af-a793-2592820678e5",
            "isItemActionType": false,
            "isCategoryActionType": false,
            "isSectionActionType": false
          },
          "sectionNameCapitalisation": "sample string 15",
          "categoryNameCapitalisation": "sample string 16",
          "itemAndItemModifierNameCapitalisation": "sample string 17",
          "itemDescriptionCapitalisation": "sample string 18",
          "displaySyncOrderHistoryButton": true,
          "defaultLandingPage": "sample string 20"
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}