> For the complete documentation index, see [llms.txt](https://developer.esw.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.esw.com/api-reference/pricing-advisor-api/models.md).

# Models

## The BulkTaxAndDutyRatesRequest object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"BulkTaxAndDutyRatesRequest":{"required":["tenantIds"],"type":"object","properties":{"tenantIds":{"type":"array","items":{"type":"string"},"description":"The list of tenant IDs to retrieve rates for. Required — must not be null."},"countryCodes":{"type":"array","items":{"type":"string"},"description":"The list of country ISO codes to filter by. Optional — if null or empty, all countries for each tenant are returned.","nullable":true}},"additionalProperties":false,"description":"Request body for the bulk Tax and Duty rates endpoint."}}}}
```

## The CategoryResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"CategoryResponse":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the identifier.","nullable":true,"readOnly":true},"estimatedTax":{"type":"number","description":"Gets or sets the estimated tax.","format":"double","readOnly":true},"estimatedFee":{"type":"number","description":"Gets the estimated fee rate.","format":"double","readOnly":true},"estimatedDuty":{"type":"number","description":"Gets or sets the estimated duty.","format":"double","readOnly":true},"shippingUpliftPercentage":{"type":"number","description":"Gets the shipping uplift percentage.","format":"double","readOnly":true},"retailerAdjustment":{"type":"number","description":"Gets or sets the retailer adjustment.","format":"double","readOnly":true},"roundingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/RoundingConfigurationResponse"},"description":"Gets or sets the rounding models.","nullable":true,"readOnly":true},"currencyDisplays":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyDisplayResponse"},"description":"Gets or sets the currency displays.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Category"},"RoundingConfigurationResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"direction":{"type":"string","description":"Gets or sets the rounding direction.","nullable":true,"readOnly":true},"model":{"type":"string","description":"Gets or sets the model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Rounding Model"},"CurrencyDisplayResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencySymbol":{"type":"string","description":"Gets or sets the currency symbol.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"decimalSeparator":{"type":"string","description":"Gets or sets the decimal separator.","nullable":true,"readOnly":true},"thousandSeparator":{"type":"string","description":"Gets or sets the thousand separator.","nullable":true,"readOnly":true},"showTrailingZeros":{"type":"boolean","description":"Gets or sets a value indicating whether [show trailing zeros].","readOnly":true},"configurationString":{"type":"string","description":"Gets or sets the configuration string.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Currency Display"}}}}
```

## The CurrencyDisplayResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"CurrencyDisplayResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencySymbol":{"type":"string","description":"Gets or sets the currency symbol.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"decimalSeparator":{"type":"string","description":"Gets or sets the decimal separator.","nullable":true,"readOnly":true},"thousandSeparator":{"type":"string","description":"Gets or sets the thousand separator.","nullable":true,"readOnly":true},"showTrailingZeros":{"type":"boolean","description":"Gets or sets a value indicating whether [show trailing zeros].","readOnly":true},"configurationString":{"type":"string","description":"Gets or sets the configuration string.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Currency Display"}}}}
```

## The FxRateResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"FxRateResponse":{"type":"object","properties":{"from":{"type":"string","description":"Gets from.","nullable":true,"readOnly":true},"to":{"type":"string","description":"Gets to.","nullable":true,"readOnly":true},"rate":{"type":"number","description":"Gets the rate.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Class FxRateResponse."}}}}
```

## The MultiplierAdviceResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"MultiplierAdviceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Gets the identifier.","nullable":true,"readOnly":true},"version":{"type":"string","description":"Gets the version.","nullable":true,"readOnly":true},"countryIso":{"type":"string","description":"Gets the country iso.","nullable":true,"readOnly":true},"lastUpdated":{"type":"string","description":"The UTC date and time that this piece of pricing advice was last updated.","nullable":true,"readOnly":true},"tenantIdentifier":{"type":"string","description":"Gets the tenant identifier.","nullable":true,"readOnly":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/MultiplierCategoryResponse"},"description":"Gets the categories.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Multiplier Pricing Advice Response"},"MultiplierCategoryResponse":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the identifier.","nullable":true,"readOnly":true},"multipliers":{"type":"array","items":{"$ref":"#/components/schemas/MultiplierResponse"},"description":"Gets the multiplier.","nullable":true,"readOnly":true},"roundingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/RoundingConfigurationResponse"},"description":"Gets or sets the rounding models.","nullable":true,"readOnly":true},"currencyDisplays":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyDisplayResponse"},"description":"Gets or sets the currency displays.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Multiplier Category Response"},"MultiplierResponse":{"type":"object","properties":{"fromCurrencyIso":{"type":"string","description":"Gets or sets from currency iso.","nullable":true,"readOnly":true},"toCurrencyIso":{"type":"string","description":"Converts to currencyiso.","nullable":true,"readOnly":true},"value":{"type":"number","description":"Standard multiplier value, includes FX rates, retailer adjustment, estimated duties, estimated taxes.","format":"double","readOnly":true},"adjustedValue":{"type":"number","description":"A multiplier value that has been adjusted to account for the countries input/pricing model. Includes FX rates, retailer adjustment, and estimated rates that are included in the input model.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Class MultiplierResponse."},"RoundingConfigurationResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"direction":{"type":"string","description":"Gets or sets the rounding direction.","nullable":true,"readOnly":true},"model":{"type":"string","description":"Gets or sets the model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Rounding Model"},"CurrencyDisplayResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencySymbol":{"type":"string","description":"Gets or sets the currency symbol.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"decimalSeparator":{"type":"string","description":"Gets or sets the decimal separator.","nullable":true,"readOnly":true},"thousandSeparator":{"type":"string","description":"Gets or sets the thousand separator.","nullable":true,"readOnly":true},"showTrailingZeros":{"type":"boolean","description":"Gets or sets a value indicating whether [show trailing zeros].","readOnly":true},"configurationString":{"type":"string","description":"Gets or sets the configuration string.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Currency Display"}}}}
```

## The MultiplierCategoryResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"MultiplierCategoryResponse":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the identifier.","nullable":true,"readOnly":true},"multipliers":{"type":"array","items":{"$ref":"#/components/schemas/MultiplierResponse"},"description":"Gets the multiplier.","nullable":true,"readOnly":true},"roundingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/RoundingConfigurationResponse"},"description":"Gets or sets the rounding models.","nullable":true,"readOnly":true},"currencyDisplays":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyDisplayResponse"},"description":"Gets or sets the currency displays.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Multiplier Category Response"},"MultiplierResponse":{"type":"object","properties":{"fromCurrencyIso":{"type":"string","description":"Gets or sets from currency iso.","nullable":true,"readOnly":true},"toCurrencyIso":{"type":"string","description":"Converts to currencyiso.","nullable":true,"readOnly":true},"value":{"type":"number","description":"Standard multiplier value, includes FX rates, retailer adjustment, estimated duties, estimated taxes.","format":"double","readOnly":true},"adjustedValue":{"type":"number","description":"A multiplier value that has been adjusted to account for the countries input/pricing model. Includes FX rates, retailer adjustment, and estimated rates that are included in the input model.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Class MultiplierResponse."},"RoundingConfigurationResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"direction":{"type":"string","description":"Gets or sets the rounding direction.","nullable":true,"readOnly":true},"model":{"type":"string","description":"Gets or sets the model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Rounding Model"},"CurrencyDisplayResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencySymbol":{"type":"string","description":"Gets or sets the currency symbol.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"decimalSeparator":{"type":"string","description":"Gets or sets the decimal separator.","nullable":true,"readOnly":true},"thousandSeparator":{"type":"string","description":"Gets or sets the thousand separator.","nullable":true,"readOnly":true},"showTrailingZeros":{"type":"boolean","description":"Gets or sets a value indicating whether [show trailing zeros].","readOnly":true},"configurationString":{"type":"string","description":"Gets or sets the configuration string.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Currency Display"}}}}
```

## The MultiplierResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"MultiplierResponse":{"type":"object","properties":{"fromCurrencyIso":{"type":"string","description":"Gets or sets from currency iso.","nullable":true,"readOnly":true},"toCurrencyIso":{"type":"string","description":"Converts to currencyiso.","nullable":true,"readOnly":true},"value":{"type":"number","description":"Standard multiplier value, includes FX rates, retailer adjustment, estimated duties, estimated taxes.","format":"double","readOnly":true},"adjustedValue":{"type":"number","description":"A multiplier value that has been adjusted to account for the countries input/pricing model. Includes FX rates, retailer adjustment, and estimated rates that are included in the input model.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Class MultiplierResponse."}}}}
```

## The PricingAdviceResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"PricingAdviceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Gets the identifier.","nullable":true,"readOnly":true},"version":{"type":"string","description":"Gets the version.","nullable":true,"readOnly":true},"countryIso":{"type":"string","description":"Gets the country iso.","nullable":true,"readOnly":true},"lastUpdated":{"type":"string","description":"The UTC date and time that this piece of pricing advice was last updated.","nullable":true,"readOnly":true},"tenantIdentifier":{"type":"string","description":"Gets the tenant identifier.","nullable":true,"readOnly":true},"fxRates":{"type":"array","items":{"$ref":"#/components/schemas/FxRateResponse"},"description":"Gets the fx rates.","nullable":true,"readOnly":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryResponse"},"description":"Gets the categories.","nullable":true,"readOnly":true},"merchandisePricingModel":{"$ref":"#/components/schemas/PricingModelResponse"}},"additionalProperties":false,"description":"Pricing Advice Response"},"FxRateResponse":{"type":"object","properties":{"from":{"type":"string","description":"Gets from.","nullable":true,"readOnly":true},"to":{"type":"string","description":"Gets to.","nullable":true,"readOnly":true},"rate":{"type":"number","description":"Gets the rate.","format":"double","readOnly":true}},"additionalProperties":false,"description":"Class FxRateResponse."},"CategoryResponse":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the identifier.","nullable":true,"readOnly":true},"estimatedTax":{"type":"number","description":"Gets or sets the estimated tax.","format":"double","readOnly":true},"estimatedFee":{"type":"number","description":"Gets the estimated fee rate.","format":"double","readOnly":true},"estimatedDuty":{"type":"number","description":"Gets or sets the estimated duty.","format":"double","readOnly":true},"shippingUpliftPercentage":{"type":"number","description":"Gets the shipping uplift percentage.","format":"double","readOnly":true},"retailerAdjustment":{"type":"number","description":"Gets or sets the retailer adjustment.","format":"double","readOnly":true},"roundingConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/RoundingConfigurationResponse"},"description":"Gets or sets the rounding models.","nullable":true,"readOnly":true},"currencyDisplays":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyDisplayResponse"},"description":"Gets or sets the currency displays.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Category"},"RoundingConfigurationResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"direction":{"type":"string","description":"Gets or sets the rounding direction.","nullable":true,"readOnly":true},"model":{"type":"string","description":"Gets or sets the model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Rounding Model"},"CurrencyDisplayResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencySymbol":{"type":"string","description":"Gets or sets the currency symbol.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"decimalSeparator":{"type":"string","description":"Gets or sets the decimal separator.","nullable":true,"readOnly":true},"thousandSeparator":{"type":"string","description":"Gets or sets the thousand separator.","nullable":true,"readOnly":true},"showTrailingZeros":{"type":"boolean","description":"Gets or sets a value indicating whether [show trailing zeros].","readOnly":true},"configurationString":{"type":"string","description":"Gets or sets the configuration string.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Currency Display"},"PricingModelResponse":{"type":"object","properties":{"id":{"type":"string","description":"The input models ID.","nullable":true,"readOnly":true},"applicableRates":{"type":"array","items":{"type":"string"},"description":"The list of rates that are applicable to estimated prices based on the currency input model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Represents a pricing model response."}}}}
```

## The PricingModelResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"PricingModelResponse":{"type":"object","properties":{"id":{"type":"string","description":"The input models ID.","nullable":true,"readOnly":true},"applicableRates":{"type":"array","items":{"type":"string"},"description":"The list of rates that are applicable to estimated prices based on the currency input model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Represents a pricing model response."}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The RoundingConfigurationResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"RoundingConfigurationResponse":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Gets or sets the currency iso.","nullable":true,"readOnly":true},"currencyExponent":{"type":"integer","description":"Gets or sets the currency exponent.","format":"int32","readOnly":true},"direction":{"type":"string","description":"Gets or sets the rounding direction.","nullable":true,"readOnly":true},"model":{"type":"string","description":"Gets or sets the model.","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"Rounding Model"}}}}
```

## The TaxAndDutyRateResponse object

```json
{"openapi":"3.0.4","info":{"title":"Pricing Advisor API","version":"4.0"},"components":{"schemas":{"TaxAndDutyRateResponse":{"type":"object","properties":{"tenantId":{"type":"string","description":"Gets the tenant identifier.","nullable":true,"readOnly":true},"countryIso":{"type":"string","description":"Gets the country ISO code.","nullable":true,"readOnly":true},"estimatedTax":{"type":"number","description":"Gets the estimated tax rate.","format":"double","nullable":true,"readOnly":true},"estimatedDuty":{"type":"number","description":"Gets the estimated duty rate.","format":"double","nullable":true,"readOnly":true},"estimatedFee":{"type":"number","description":"Gets the estimated fee rate.","format":"double","nullable":true,"readOnly":true},"shippingUpliftPercentage":{"type":"number","description":"Gets the shipping uplift percentage.","format":"double","nullable":true,"readOnly":true},"retailerAdjustment":{"type":"number","description":"Gets the retailer adjustment.","format":"double","nullable":true,"readOnly":true}},"additionalProperties":false,"description":"A single entry in the bulk Tax and Duty rates response.\nContains the Default category rates for one tenant/country combination."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.esw.com/api-reference/pricing-advisor-api/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.