Methods

Pricing Advisor API v4.0 includes the following methods

GET/`Retrieve Pricing Data For All Countries`

To retrieve the pricing data for all delivery countries, send a GET request to /api/v2/RetailerCatalog

Required Parameters

tenantCoderequiredstring

Required: Six-letter name that identifies the brand. The identifier maps to a secure token claim.

Example: CASUAL

Note:
If a particular country is not fully configured, then its data will not be returned. Make sure that Pricing Advisor is returning all expected countries. If not, then get in touch with ESW.

It is recommended that you do not default your price to 0 if pricing advice is missing. Rather:

Use cached data
Request an older version of pricing advice using api/4.0/StandardAdvice/{id}/archived
Error out that product

Optional Parameters

None

Status Code

Status Code	Description
200 (OK)	Request was successful. The response body contains pricing data for all delivery countries.
400 (Bad Request)	Request contains errors. Example: missing mandatory parameters.
401 (Unauthorized)	Invalid or missing authentication credentials for the requested resource.
403 (Forbidden)	Access is forbidden.
404 (Not Found)	System could not locate the requested resource.
503 (Service Unavailable)	Server is temporarily unable to handle the request.

Request Example

Info: For more information on the unique API responses, refer to the Pricing Advisor API Responses page.

GET /api/4.0/StandardAdvice/{tenantCode}

This endpoint retrieves pricing data (standard advice) for all delivery countries associated with the specified tenant code.

Request

Method: GET

Endpoint: /api/4.0/StandardAdvice/{tenantCode}

Path Parameter

Parameter	Type	Description
tenantCode	string	Six-letter brand identifier. Maps to a secure token claim. Example: `ECBECB`

Request

GET /api/4.0/StandardAdvice/{tenantCode}

Response

[
  {
    "id": "ECBECB_GB_a43e1253-f727-4490-a98c-e6f0ee063eab",
    "version": "a43e1253-f727-4490-a98c-e6f0ee063eab",
    "countryIso": "GB",
    "tenantIdentifier": "ECBECB",
    "merchandisePricingModel": "ALLINCLUSIVE",
    "fxRates": [
      {
        "from": "GBP",
        "to": "GBP",
        "rate": 1
      },
      {
        "from": "GBP",
        "to": "EUR",
        "rate": 1.1290647807
      },
      {
        "from": "GBP",
        "to": "ALL",
        "rate": 130.8047311602
      }
    ],
    "categories": [
      {
        "id": "default",
        "estimatedTax": 20,
        "estimatedFee": 0,
        "estimatedDuty": 11,
        "retailerAdjustment": 3,
        "roundingConfigurations": [
          {
            "currencyIso": "GBP",
            "currencyExponent": 2,
            "direction": "Nearest",
            "model": "multiple1.multiple1"
          }
        ],
        "currencyDisplays": [
          {
            "currencyIso": "GBP",
            "currencySymbol": "£",
            "currencyExponent": 2,
            "decimalSeparator": ".",
            "thousandSeparator": ",",
            "showTrailingZeros": true,
            "configurationString": "[CurrencySymbol][Number][DecimalSeparator][Exponent]"
          },
          {
            "currencyIso": "EUR",
            "currencySymbol": "€",
            "currencyExponent": 2,
            "decimalSeparator": ".",
            "thousandSeparator": ",",
            "showTrailingZeros": true,
            "configurationString": "[Number][DecimalSeparator][Exponent] [CurrencySymbol]"
          },
          {
            "currencyIso": "ALL",
            "currencySymbol": "Lek",
            "currencyExponent": 2,
            "decimalSeparator": ",",
            "thousandSeparator": ".",
            "showTrailingZeros": true,
            "configurationString": "[Number][DecimalSeparator][Exponent] [CurrencyISO]"
          }
        ]
      }
    ]
  },
  {
    "id": "ECBECB_IE_2db96559-05c8-4147-ad90-d2367e4f0a98",
    "version": "2db96559-05c8-4147-ad90-d2367e4f0a98",
    "countryIso": "IE",
    "tenantIdentifier": "ECBECB",
    "merchandisePricingModel": "ALLINCLUSIVE",
    "fxRates": [
      {
        "from": "EUR",
        "to": "EUR",
        "rate": 1
      }
    ],
    "categories": [
      {
        "id": "default",
        "estimatedTax": 6,
        "estimatedFee": 0,
        "estimatedDuty": 5,
        "retailerAdjustment": 7,
        "roundingConfigurations": [
          {
            "currencyIso": "EUR",
            "currencyExponent": 2,
            "direction": "Up",
            "model": "none.none"
          }
        ],
        "currencyDisplays": [
          {
            "currencyIso": "EUR",
            "currencySymbol": "€",
            "currencyExponent": 2,
            "decimalSeparator": ".",
            "thousandSeparator": ",",
            "showTrailingZeros": true,
            "configurationString": "none"
          }
        ]
      }
    ]
  }

GET/`Retrieve Pricing Data For A Specific Country`

To retrieve the pricing data for a specific delivery country, send a GET request to api/4.0/StandardAdvice/{tenantCode}/{countryIso}

Required Parameters

tenantCoderequiredstring

Six-letter name that identifies the brand. The identifier maps to a secure token claim.
Example: CASUAL

countryIsorequiredstring

ISO 3166 code of the delivery country that will be impacted by the product price adjustment.
Example: IE

Status Code

Status Code	Description
200 (OK)	Indicates that your request was successful. The response body contains the pricing data for all delivery countries.
400 (Bad Request)	Indicates that your request contains errors and could not be completed. For instance, if the mandatory parameters are missing.
401 (Unauthorized)	Indicates that your request has not been completed because it does not consist of valid authentication credentials for the requested resource.
403 (Forbidden)	Indicates that the access is forbidden.
404 (Not Found)	Indicates that the system is unable to locate the resource.
503 (Service Unavailable)	Indicates that the server is temporarily unable to handle the request.

Info

For more information on the unique API responses, refer to the Pricing Advisor API Responses page.

Request Example

GET /api/4.0/StandardAdvice/{tenantCode}/{countryIso}

This endpoint retrieves pricing data (standard advice) for a specific delivery country associated with the provided tenant code.

Request

Method: GET

Endpoint: /api/4.0/StandardAdvice/{tenantCode}/{countryIso}

Path Parameters

Parameter	Type	Description
tenantCode	string	Six-letter brand identifier. Maps to a secure token claim. Example: `ECBECB`
countryIso	string	ISO 3166 code of the delivery country for which pricing data is requested. Example: `IE`

Request

GET /api/4.0/StandardAdvice/{tenantCode}/{countryIso}

Response

{
"id": "ECBECB_IE_2db96559-05c8-4147-ad90-d2367e4f0a98",
"version": "2db96559-05c8-4147-ad90-d2367e4f0a98",
"countryIso": "IE",
"tenantIdentifier": "ECBECB",
"merchandisePricingModel": "ALLINCLUSIVE",
"fxRates": [
  {
    "from": "EUR",
    "to": "EUR",
    "rate": 1
  }
],
"categories": [
  {
    "id": "default",
    "estimatedTax": 6,
    "estimatedFee": 0,
    "estimatedDuty": 5,
    "retailerAdjustment": 7,
    "roundingConfigurations": [
      {
        "currencyIso": "EUR",
        "currencyExponent": 2,
        "direction": "Up",
        "model": "none.none"
      }
    ],
    "currencyDisplays": [
      {
        "currencyIso": "EUR",
        "currencySymbol": "€",
        "currencyExponent": 2,
        "decimalSeparator": ".",
        "thousandSeparator": ",",
        "showTrailingZeros": true,
        "configurationString": "none"
      }
    ]
  }
]
}

Status Code	Description
200 (OK)	Indicates that your request was successful. The response body contains the pricing data for all delivery countries
400 (Bad Request)	Indicates that your request contains errors and could not be completed. For instance, if the mandatory parameters are missing.
401 (Unauthorized)	Indicates that your request has not been completed because it does not consist of valid authentication credentials for the requested resource.
403 (Forbidden)	Indicates that the access is forbidden.
404 (Not Found)	Indicates that the system is unable to locate the resource.
503 (Service Unavailable)	Indicates that the server is temporarily unable to handle the request.

Info: For more information on the unique API responses, refer to the Pricing Advisor API Responses page.

Parameter	Type	Description
id	string	Six-letter brand identifier. The identifier maps to a secure token claim. Example: `CAUSAL`

Request

GET api/4.0/ StandardAdvice/{id}/ archived

Response

{
  "id": "string",
  "version": "string",
  "countryIso": "string",
  "tenantIdentifier": "string",
  "merchandisePricingModel": "string",
  "fxRates": [
    {
      "from": "string",
      "to": "string",
      "rate": 0
    }
  ],
  "categories": [
    {
      "id": "string",
      "estimatedTax": 0,
      "estimatedFee": 0,
      "estimatedDuty": 0,
      "retailerAdjustment": 0,
      "roundingConfigurations": [
        {
          "currencyIso": "string",
          "currencyExponent": 0,
          "direction": "string",
          "model": "string"
        }
      ],
      "currencyDisplays": [
        {
          "currencyIso": "string",
          "currencySymbol": "string",
          "currencyExponent": 0,
          "decimalSeparator": "string",
          "thousandSeparator": "string",
          "showTrailingZeros": true,
          "configurationString": "string"
        }
      ]
    }
  ]
}

Overview

Allows you to retrieve pricing data for countries where you want to sell your products

Sample Integration

How you can use the data from the ESW Pricing Advisor v4.0 to calculate product prices in the shopper currency

On this page

GET/Retrieve Pricing Data For All Countries
GET/Retrieve Pricing Data For A Specific Country