Skip to content

SparkLayer Price List XML

This XML format represents price lists in SparkLayer. It only contains header level information, such as the price list name. There is no information relating to the prices within the price list. Please refer to Product Pricing XML for details about how to send prices to SparkLayer.

Tasks

Minimal XML Sample

The XML below represents the minimum information that needs to be provided to create a price list in SparkLayer.

<?xml version="1.0"?>
<PriceLists>
    <PriceList>
        <Slug>trade-prices</Slug>
        <Name>Trade Prices</Name>
        <CurrencyCode>GBP</CurrencyCode>
    </PriceList>
</PriceLists>

Price List

The following information can be provided for the price list:

XML Field  Example  Field Type  Input  Description
ExternalId 123 string Optional Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
Slug trade-prices string Required Unique identifier for the price list. Max 30 chars
Name Trade Prices string Required The name of the price list. Max 64 chars
CurrencyCode GBP string Required The ISO 4217 currency code of the price list.
Source integration enum Optional Valid values: integration, custom, platform
SourcePriceListSlug retail-prices string Optional The slug of the source price list. Max 30 chars
AdjustmentPercentage 0.10 decimal Optional Adjustment percent expressed as a decimal between 0 and 1.
AdjustmentDirection minus enum Optional Valid values: plus, minus
CurrencyExchangeRate 1.254324 decimal Optional Exchange rate between the source price list currency and the parent price list. If not specified, will be set based on current market rates. 
<?xml version="1.0"?>
<PriceLists>
    <PriceList>
        <ExternalId>123</ExternalId>
        <Slug>trade-prices</Slug>
        <Name>Trade Prices</Name>
        <CurrencyCode>GBP</CurrencyCode>
        <Source>integration</Source>
        <Rules>
            <Rule>
                <SourcePriceListSlug>retail-prices</SourcePriceListSlug>
                <AdjustmentPercentage>0.10</AdjustmentPercentage>
                <AdjustmentDirection>minus</AdjustmentDirection>
                <CurrencyExchangeRate>1.254324</CurrencyExchangeRate>
            </Rule>
        </Rules>
    </PriceList>
</PriceLists>

Complete XML Sample

This sample shows all data that can be provided via our price list XML format.

<?xml version="1.0"?>
<PriceLists>
    <PriceList>
        <ExternalId>123</ExternalId>
        <Slug>trade-prices</Slug>
        <Name>Trade Prices</Name>
        <CurrencyCode>GBP</CurrencyCode>
        <Source>integration</Source>
        <Rules>
            <Rule>
                <SourcePriceListSlug>retail-prices</SourcePriceListSlug>
                <AdjustmentPercentage>0.10</AdjustmentPercentage>
                <AdjustmentDirection>minus</AdjustmentDirection>
                <CurrencyExchangeRate>1.254324</CurrencyExchangeRate>
            </Rule>
        </Rules>
    </PriceList>
    <PriceList>
        <ExternalId>456</ExternalId>
        <Slug>web-prices</Slug>
        <Name>Web Prices</Name>
        <CurrencyCode>GBP</CurrencyCode>
        <Source>integration</Source>
        <Rules>
            <Rule>
                <SourcePriceListSlug>retail-prices</SourcePriceListSlug>
                <AdjustmentPercentage>0.05</AdjustmentPercentage>
                <AdjustmentDirection>minus</AdjustmentDirection>
                <CurrencyExchangeRate>1.254324</CurrencyExchangeRate>
            </Rule>
        </Rules>
    </PriceList>
</PriceLists>