Pricing Advisor API - Protocol API Reference

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

Get Archived Multiplier Advice

This endpoint retrieves archived multiplier-based pricing advice for a given ID. Use this to review historical pricing guidance associated with a tenant and country combination.

Path Parameters

Name
id
Type
string
Description
The unique ID of the archived multiplier advice record.

Request

GET

/api/4.0/MultiplierAdvice/{id}/archived

curl -X GET https://api.example.com/api/4.0/MultiplierAdvice/abc123/archived

Response (200 OK)

{
  "id": "abc123",
  "version": "1.0.0",
  "countryIso": "IE",
  "lastUpdated": "2024-11-01T10:00:00Z",
  "tenantIdentifier": "ESW",
  "categories": [
    {
      "categoryCode": "FASHION",
      "multiplier": 1.15
    },
    {
      "categoryCode": "COSMETICS",
      "multiplier": 1.20
    }
  ]
}

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

Get Multiplier Advice by Tenant and Country

This endpoint retrieves the current multiplier-based pricing advice for a specified tenant and country. The response includes multiplier factors for each category to be applied to base product prices.

Path Parameters

Name
tenantCode
Type
string
Description
The unique identifier for the tenant (e.g. ESW).
Name
countryIso
Type
string
Description
The ISO Alpha-2 country code (e.g. IE, FR).

Request

GET

/api/4.0/MultiplierAdvice/{tenantCode}/{countryIso}

curl -X GET https://api.example.com/api/4.0/MultiplierAdvice/ESW/IE

Response (200 OK)

{
  "id": "abc123",
  "version": "1.0.0",
  "countryIso": "IE",
  "lastUpdated": "2024-11-01T10:00:00Z",
  "tenantIdentifier": "ESW",
  "categories": [
    {
      "categoryCode": "FASHION",
      "multiplier": 1.15
    },
    {
      "categoryCode": "COSMETICS",
      "multiplier": 1.20
    }
  ]
}

GET/api/4.0/MultiplierAdvice/{tenantCode}

List Multiplier Advice by Tenant

This endpoint retrieves a list of multiplier-based pricing advice for all countries associated with the specified tenant. It’s useful for auditing or syncing country-specific multiplier logic at once.

Path Parameters

Name
tenantCode
Type
string
Description
The unique identifier for the tenant (e.g. ESW).

Request

GET

/api/4.0/MultiplierAdvice/{tenantCode}

curl -X GET https://api.example.com/api/4.0/MultiplierAdvice/ESW

Response (200 OK)

[
  {
    "id": "advice001",
    "version": "1.0.0",
    "countryIso": "IE",
    "lastUpdated": "2024-11-01T10:00:00Z",
    "tenantIdentifier": "ESW",
    "categories": [
      {
        "categoryCode": "FASHION",
        "multiplier": 1.15
      },
      {
        "categoryCode": "COSMETICS",
        "multiplier": 1.20
      }
    ]
  },
  {
    "id": "advice002",
    "version": "1.0.0",
    "countryIso": "FR",
    "lastUpdated": "2024-11-01T11:00:00Z",
    "tenantIdentifier": "ESW",
    "categories": [
      {
        "categoryCode": "FASHION",
        "multiplier": 1.25
      }
    ]
  }
]

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

Get Archived Standard Advice

This endpoint retrieves archived standard pricing advice for a specific ID. Standard pricing includes full calculation context like FX rates, pricing model, and category details.

Path Parameters

Name
id
Type
string
Description
The unique identifier of the archived standard advice.

Request

GET

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

curl -X GET https://api.example.com/api/4.0/StandardAdvice/abc123/archived

Response (200 OK)

{
  "id": "abc123",
  "version": "1.0.0",
  "countryIso": "IE",
  "lastUpdated": "2024-10-12T08:30:00Z",
  "tenantIdentifier": "ESW",
  "fxRates": [
    {
      "fromCurrency": "USD",
      "toCurrency": "JPY",
      "rate": 145.75
    }
  ],
  "categories": [
    {
      "categoryCode": "FASHION",
      "basePrice": 100,
      "adjustedPrice": 115,
      "finalPrice": 132
    }
  ],
  "merchandisePricingModel": {
    "dutyRate": 0.05,
    "taxRate": 0.20,
    "feeRate": 0.10
  }
}

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

Get Standard Advice by Tenant and Country

This endpoint retrieves the standard pricing advice for a specific tenant and country. It returns price calculations based on duty, tax, fees, and foreign exchange, applicable at category level.

Path Parameters

Name
tenantCode
Type
string
Description
Unique identifier for the tenant (e.g. ESW).
Name
countryIso
Type
string
Description
ISO Alpha-2 code for the country (e.g. IE, DE).

Request

GET

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

curl -X GET https://api.example.com/api/4.0/StandardAdvice/ESW/IE

Response (200 OK)

{
  "id": "abc123",
  "version": "1.0.0",
  "countryIso": "IE",
  "lastUpdated": "2024-10-12T08:30:00Z",
  "tenantIdentifier": "ESW",
  "fxRates": [
    {
      "fromCurrency": "USD",
      "toCurrency": "JPY",
      "rate": 145.75
    }
  ],
  "categories": [
    {
      "categoryCode": "FASHION",
      "basePrice": 100,
      "adjustedPrice": 115,
      "finalPrice": 132
    }
  ],
  "merchandisePricingModel": {
    "dutyRate": 0.05,
    "taxRate": 0.20,
    "feeRate": 0.10
  }
}

GET/api/4.0/StandardAdvice/{tenantCode}

List Standard Advice by Tenant

This endpoint retrieves a list of standard pricing advice records across all supported countries for a given tenant. Each record includes exchange rates, pricing models, and category-level price breakdowns.

Path Parameters

Name
tenantCode
Type
string
Description
The unique tenant identifier (e.g. ESW).

Request

GET

/api/4.0/StandardAdvice/{tenantCode}

curl -X GET https://api.example.com/api/4.0/StandardAdvice/ESW

Response (200 OK)

[
  {
    "id": "advice001",
    "version": "1.0.0",
    "countryIso": "IE",
    "lastUpdated": "2024-10-12T08:30:00Z",
    "tenantIdentifier": "ESW",
    "fxRates": [
      {
        "fromCurrency": "USD",
        "toCurrency": "JPY",
        "rate": 145.75
      }
    ],
    "categories": [
      {
        "categoryCode": "FASHION",
        "basePrice": 100,
        "adjustedPrice": 115,
        "finalPrice": 132
      }
    ],
    "merchandisePricingModel": {
      "dutyRate": 0.05,
      "taxRate": 0.20,
      "feeRate": 0.10
    }
  }
]