Fetch checkout settings

Use the checkoutSettings query to fetch certain marketplace settings that can be leveraged during the Checkout process.

Here are some of the marketplace settings that are relevant to Checkout:

Setting name	Description
tenant	A unique code or identifier of the marketplace.
marketplaceBaseUrl	The base URL of the marketplace.
supportEmail	The email ID of support in different locales.
supportPhone	The contact number of support.
supportedLocales	Represents the locales supported by the marketplace.
defaultLocale	Represents the default locale configured on the Marketplace.
marketplaceLogoUrl	A unique code or identifier of the marketplace.
marketplaceFaviconUrl	The URL of the favicon image uploaded in the marketplace.
marketplaceTermsAndConditionsUrl	The URL for the marketplace terms and conditions in different locales.
marketplacePrivacyUrl	The URL of the marketplace privacy policy in different locales.
flatTaxRate	The flat tax rate that is applied to prices.
allowDiscountCredit	The setting to determine If the total order price is less than the applied fixed-price discount value. Anything extra will be credited to the customer.
shippingCostEnabled	Indicates if the Marketplace Manager has enabled or defined the shipping costs based on total value of the order.

Query:

query checkoutSettings {
  checkoutSettings {
    allowDiscountCredit
    defaultLocale
    marketplaceBaseUrl
    flatTaxRate
    marketplaceFaviconUrl
    marketplaceLogoUrl
    shippingCostEnabled
    supportPhone
    supportedLocales
    tenant
    supportEmail {
      locale
      value
    }
    marketplaceTermsAndConditionsUrl {
      locale
      value
    }
    marketplacePrivacyUrl {
      locale
      value
    }
  }
 }

Sample output:

{
  "data": {
    "checkoutSettings": {
      "allowDiscountCredit": false,
      "defaultLocale": "en-US",
      "marketplaceBaseUrl": "https://engage19billing.test.devappdirect.me/",
      "flatTaxRate": 0.0775,
      "marketplaceFaviconUrl": "https://d33na3ni6eqf5j.cloudfront.net/marketplace_favicon/img2215763989268234956.jpg?291f565d5f467161bc179ef74050d2d4",
      "marketplaceLogoUrl": "https://d33na3ni6eqf5j.cloudfront.net/marketplace_logo/img5456757645046230491.jpg?2b1671c50b21fb5f91e434dbdf00a7d7",
      "shippingCostEnabled": true,
      "supportPhone": "(403) 999-9999",
      "supportedLocales": [
        "en-US",
        "it-CH",
        "fr-CA"
      ],
      "tenant": "ENGAGE19BILLING",
      "supportEmail": [
        {
          "locale": "en-US",
          "value": "supportenus@example.com"
        },
        {
          "locale": "it-CH",
          "value": "supportitch@example.com"
        },
     
        {
          "locale": "fr-CA",
          "value": "supportfrca@example.com"
        }
      ],
      "marketplaceTermsAndConditionsUrl": [
       
        {
          "locale": "en-US",
          "value": "https://www.example.com/?terms&test=2"
        },
       
        {
          "locale": "it-CH",
          "value": "https://www.example.com/it-ch/terms"
        },
        {
          "locale": "fr-CA",
          "value": "https://www.example.com/fr-ca/terms"
        }
      ],
      "marketplacePrivacyUrl": [
        {
          "locale": "en-US",
          "value": "https://www.example.com/privacy1"
        }, 
        {
          "locale": "it-CH",
          "value": "https://www.example.com/it-ch/privacy"
        },
        {
          "locale": "fr-CA",
          "value": "https://www.example.com/fr-ca/privacy"
        }
      ]
    }
  }
}

Common errors

For information on some of the common errors related to this mutation, refer to the section on Error handling.