Open API v2 / eCommerce / eCommerce Settings

eCommerce Settings

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/ecommerce-settings#

Retrieves a ecommerce settings

Response
GroupTitlestring · nullable
Heading of the settings group this block of fields belongs to, used to organize the eCommerce settings screen.
Fieldsarray of objects
The individual settings that make up this group, each with its own title, value, and type.
curl "https://your-site.webinone.com/api/v2/admin/ecommerce-settings" \
  -H "Authorization: Bearer <token>"
Response · 200
[
  {
    "GroupTitle": "string",
    "Fields": [
      {
        "Description": [
          "string"
        ],
        "Options": [
          "string"
        ],
        "Value": "string",
        "ValueType": "BooleanValue",
        "FieldType": "MainCSS",
        "Title": "string"
      }
    ]
  }
]
PUT/api/v2/admin/ecommerce-settings#

Updates an existing ecommerce settings

Body parameters
ShoppingCartLifeTimeInHoursintegerrequired
The number of hours a user's shopping cart will remain active and accessible. The minimum value allowed in this setting is 1 hour and the maximum is 876000 hours.
AbandonedCartTimeInHoursinteger · nullable
The minimum value allowed in this setting is 1 hour and the maximum is 876000 hours. This setting is only available when using the Aboandoned Cart Recovery extension.
DimensionUnitsenumrequired
The unit of measurement used for products width, height and depth dimensions for use in shipping calculations. Possible values: CM, IN, MM, M, FT, YD.Possible values: CMINMMMFTYD
WeightUnitsenumrequired
The unit of measurement used for products weight for use in shipping calculations. Possible values: KG, LB, OZ, G.Possible values: KGLBOZG
DiscountApplyTypestringrequired
The logic of applying discounts.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Codestring · nullable
A unique coupon code (for example, SUMMER2024) that the user enters in the cart.
Typeenum
Discount type. Possible values: FixedAmount, PercentageOfOrder, FreeShipping.Possible values: FixedAmountPercentageOfOrderFreeShipping
Descriptionstring · nullable
Description of the discount.
Currencystring · nullable
Discount currency.
Enabledboolean
This is the main "on/off" (boolean) of your discount or promo code.
Amountnumber
This is the numerical value of the discount amount.
MinOrderCostLimitationnumber
Minimum order amount after which the coupon becomes active.
UseExpireAfterRedemptionboolean
This is a logical switch (checkbox) that determines the coupon expiration mode.
ExpireAfterinteger
This is a numerical indicator of the coupon's lifespan in dynamic mode.
ReleaseDateTimestring · date-time
Date and time of the beginning of the action.
ExpiryDateTimestring · date-time
Date and time of expiration.
Catalogsarray of integers
An array of directory IDs. 0 is the ID of the main catalog. It tells the system which sections of the store this setting will work in.
ApplyDiscountToCatalogsboolean
A boolean flag indicating that if this setting contains a discount, it should automatically apply to all products within the above catalogs.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/ecommerce-settings" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ShoppingCartLifeTimeInHours":0,"AbandonedCartTimeInHours":0,"DimensionUnits":"CM","WeightUnits":"KG","DiscountApplyType":"string"}'
Response · 200
{
  "Id": 1,
  "Code": "string",
  "Type": "FixedAmount",
  "Description": "string",
  "Currency": "USD",
  "Enabled": false,
  "Amount": 0,
  "MinOrderCostLimitation": 0,
  "UseExpireAfterRedemption": false,
  "ExpireAfter": 0,
  "ReleaseDateTime": "2026-07-01T00: 00: 00Z",
  "ExpiryDateTime": "2026-07-01T00: 00: 00Z",
  "Catalogs": [
    0
  ],
  "ApplyDiscountToCatalogs": false
}
GET/api/v2/admin/ecommerce-settings/countries#

Retrieves a countries

Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Countrystring · nullable
Country (it is recommended to use ISO codes).
Abbreviationstring · nullable
Standard two-letter code for the country (for example, US or AU).
Codestring · nullable
A unique coupon code (for example, SUMMER2024) that the user enters in the cart.
curl "https://your-site.webinone.com/api/v2/admin/ecommerce-settings/countries" \
  -H "Authorization: Bearer <token>"
Response · 200
[
  {
    "Id": 1,
    "Country": "string",
    "Abbreviation": "string",
    "Code": "string"
  }
]
GET/api/v2/admin/ecommerce-settings/tax-and-shipping#

Retrieves a ecommerce shipping tax settings

Response
AvailableCurrencyCountryarray of objects
The currency-and-country combinations for which shipping and tax can be configured, used to populate market selectors.
AppliesToarray of objects
The entities tax can be applied to (shipping options and gift vouchers), used to drive the tax-applies-to selectors.
TaxRoundingStrategyarray of objects
The rounding strategies available for tax calculation, offered as choices in the settings UI.
Settingsarray of objects
The saved shipping and tax configuration, one entry per currency-country market.
curl "https://your-site.webinone.com/api/v2/admin/ecommerce-settings/tax-and-shipping" \
  -H "Authorization: Bearer <token>"
Response · 200
{
  "AvailableCurrencyCountry": [
    {
      "Hash": 0,
      "CurrencyId": "USD",
      "Currency": "USD",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    }
  ],
  "AppliesTo": [
    {
      "DisplayName": "Example",
      "TaxAppliesEnumeration": "ShippingOptions"
    }
  ],
  "TaxRoundingStrategy": [
    {
      "DisplayName": "Example",
      "TaxRoundingStrategy": "WithErrorCompensation"
    }
  ],
  "Settings": [
    {
      "Id": "string",
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "USD",
        "Currency": "USD",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      },
      "TaxSettings": {
        "TaxAppliesTo": [
          "ShippingOptions"
        ],
        "AutoSelectTaxIfOnlyOneOptionalAvailable": false,
        "HideIfOnlyOneTaxInTheList": false,
        "EnableTaxDrop": false,
        "TaxRoundingStrategy": "WithErrorCompensation"
      },
      "ShippingSettings": {
        "ShippingCountriesId": [
          "string"
        ],
        "DefaultCountryId": "string",
        "IsMandatoryShippingCountry": false,
        "SubtotalWithTax": false
      }
    }
  ]
}
PUT/api/v2/admin/ecommerce-settings/tax-and-shipping#

Retrieves a ecommerce shipping tax settings

Body parameters
CurrencyCountryobject
The currency-and-country market the submitted shipping and tax settings apply to.
TaxSettingsobject
Tax rules to save for this market, including what tax applies to, auto-selection behavior, and the rounding strategy.
ShippingSettingsobject
Shipping rules to save for this market, such as whether a shipping country is required and how subtotals are calculated.
Response
AvailableCurrencyCountryarray of objects
The currency-and-country combinations for which shipping and tax can be configured, used to populate market selectors.
AppliesToarray of objects
The entities tax can be applied to (shipping options and gift vouchers), used to drive the tax-applies-to selectors.
TaxRoundingStrategyarray of objects
The rounding strategies available for tax calculation, offered as choices in the settings UI.
Settingsarray of objects
The saved shipping and tax configuration, one entry per currency-country market.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/ecommerce-settings/tax-and-shipping" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"CurrencyCountry":{"Hash":0,"CurrencyId":"USD","Currency":"USD","CountryId":"string","CountryAbbreviation":"string"},"TaxSettings":{"TaxAppliesTo":["ShippingOptions"],"AutoSelectTaxIfOnlyOneOptionalAvailable":false,"HideIfOnlyOneTaxInTheList":false,"EnableTaxDrop":false,"TaxRoundingStrategy":"WithErrorCompensation"},"ShippingSettings":{"ShippingCountriesId":["string"],"DefaultCountryId":"string","IsMandatoryShippingCountry":false,"SubtotalWithTax":false}}'
Response · 200
{
  "AvailableCurrencyCountry": [
    {
      "Hash": 0,
      "CurrencyId": "USD",
      "Currency": "USD",
      "CountryId": "string",
      "CountryAbbreviation": "string"
    }
  ],
  "AppliesTo": [
    {
      "DisplayName": "Example",
      "TaxAppliesEnumeration": "ShippingOptions"
    }
  ],
  "TaxRoundingStrategy": [
    {
      "DisplayName": "Example",
      "TaxRoundingStrategy": "WithErrorCompensation"
    }
  ],
  "Settings": [
    {
      "Id": "string",
      "CurrencyCountry": {
        "Hash": 0,
        "CurrencyId": "USD",
        "Currency": "USD",
        "CountryId": "string",
        "CountryAbbreviation": "string"
      },
      "TaxSettings": {
        "TaxAppliesTo": [
          "ShippingOptions"
        ],
        "AutoSelectTaxIfOnlyOneOptionalAvailable": false,
        "HideIfOnlyOneTaxInTheList": false,
        "EnableTaxDrop": false,
        "TaxRoundingStrategy": "WithErrorCompensation"
      },
      "ShippingSettings": {
        "ShippingCountriesId": [
          "string"
        ],
        "DefaultCountryId": "string",
        "IsMandatoryShippingCountry": false,
        "SubtotalWithTax": false
      }
    }
  ]
}