RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

eCommerce Settings API

Retrieve and Update eCommerce Settings via the public API endpoint, as well as retrieve a list of available Countries and Tax and Shipping settings.

GET eCommerce Settings Item

Retrieves a single Settings record based on the endpoint URL.

/api/v2/admin/ecommerce-settings

Data / Response:

N/A

[
  {
    "GroupTitle": "string",
    "Fields": [
      {
        "Description": [
          "string"
        ],
        "Options": [
          "string"
        ],
        "Value": "string",
        "ValueType": "BooleanValue",
        "FieldType": "MainCSS",
        "Title": "string"
      }
    ]
  }
]

PUT eCommerce Settings Update

Updates the Settings based on the data provided.

/api/v2/admin/ecommerce-settings

Data / Response:

{
  "ShoppingCartLifeTimeInHours": 0,
  "AbandonedCartTimeInHours": 0,
  "DimensionUnits": "string",
  "WeightUnits": "string",
  "DiscountApplyType": "string"
}

{
  "ShoppingCartLifeTimeInHours": 0,
  "AbandonedCartTimeInHours": 0,
  "DimensionUnits": "string",
  "WeightUnits": "string",
  "DiscountApplyType": "string"
}

GET eCommerce Settings Countries List

Retrieves a list of Settings' Countries as a JSON response.

/api/v2/admin/ecommerce-settings/countries

Data / Response:

N/A

[
  {
    "Id": 0,
    "Country": "string",
    "Abbreviation": "string",
    "Code": "string"
  }
]

GET eCommerce Settings Tax and Shipping Item

Retrieves a single Settings' Tax and Shipping record based on the endpoint URL.

/api/v2/admin/ecommerce-settings/tax-and-shipping

Data / Response:

N/A

{
  "AvailableCurrencyCountry": [
    {
      "Hash": 0,
      "CurrencyId": "string",
      "Currency": "string",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    }
  ],
  "AppliesTo": [
    {
      "DisplayName": "string",
      "TaxAppliesEnumeration": "ShippingOptions"
    }
  ],
  "TaxRoundingStrategy": [
    {
      "DisplayName": "string",
      "TaxRoundingStrategy": "WithErrorCompensation"
    }
  ],
  "Settings": [
    {
      "Id": "string",
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      },
      "TaxSettings": {
        "TaxAppliesTo": [
          "ShippingOptions"
        ],
        "AutoSelectTaxIfOnlyOneOptionalAvailable": true,
        "HideIfOnlyOneTaxInTheList": true,
        "EnableTaxDrop": true,
        "TaxRoundingStrategy": "WithErrorCompensation"
      },
      "ShippingSettings": {
        "ShippingCountriesId": [
          "string"
        ],
        "DefaultCountryId": "string",
        "IsMandatoryShippingCountry": true,
        "SubtotalWithTax": true
      }
    }
  ]
}

PUT eCommerce Settings Tax and Shipping Update

Updates a single Settings' Tax and Shipping record based on the data provided.

/api/v2/admin/ecommerce-settings/tax-and-shipping

Data / Response:

{
  "CurrencyCountry": {
    "Hash": 0,
    "CurrencyId": "string",
    "Currency": "string",
    "CountryId": "string",
    "CountryAbbreviation": "string"
  },
  "TaxSettings": {
    "TaxAppliesTo": [
      "ShippingOptions"
    ],
    "AutoSelectTaxIfOnlyOneOptionalAvailable": true,
    "HideIfOnlyOneTaxInTheList": true,
    "EnableTaxDrop": true,
    "TaxRoundingStrategy": "WithErrorCompensation"
  },
  "ShippingSettings": {
    "ShippingCountriesId": [
      "string"
    ],
    "DefaultCountryId": "string",
    "IsMandatoryShippingCountry": true,
    "SubtotalWithTax": true
  }
}

{
  "AvailableCurrencyCountry": [
    {
      "Hash": 0,
      "CurrencyId": "string",
      "Currency": "string",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    }
  ],
  "AppliesTo": [
    {
      "DisplayName": "string",
      "TaxAppliesEnumeration": "ShippingOptions"
    }
  ],
  "TaxRoundingStrategy": [
    {
      "DisplayName": "string",
      "TaxRoundingStrategy": "WithErrorCompensation"
    }
  ],
  "Settings": [
    {
      "Id": "string",
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "string",
        "Currency": "string",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      },
      "TaxSettings": {
        "TaxAppliesTo": [
          "ShippingOptions"
        ],
        "AutoSelectTaxIfOnlyOneOptionalAvailable": true,
        "HideIfOnlyOneTaxInTheList": true,
        "EnableTaxDrop": true,
        "TaxRoundingStrategy": "WithErrorCompensation"
      },
      "ShippingSettings": {
        "ShippingCountriesId": [
          "string"
        ],
        "DefaultCountryId": "string",
        "IsMandatoryShippingCountry": true,
        "SubtotalWithTax": true
      }
    }
  ]
}