Pricing API

Overview

This document outlines the purpose, technology, methods and objects for using the Pricing API.

Purpose

This API provides access to customer specific pricing information on the current website and display state.

Endpoint

The Pricing API endpoint for any site is located at http://[siteurl]/api/pricing.

This endpoint is enabled for access via HTTP GET.

GET api/pricing

Request Information

URI Parameters

Name Type Description
stylesstringArray of styles to retrieve.

Sample: http://[siteurl]/api/pricing/?styles=SKU1&styles=SKU2&styles=SKU3

Body Parameters

None

Response Information

Resource Description

Name Type Description
SKUstringProduct style code.
MaxNowPricestringMaximum buy now price.
MaxWasPricestringMaximum was price.
MinNowPricestringMinimum buy now price.
MinWasPricestringMinimum was price.
Item PricingsItemPricing[]Product Item Pricings.

Response Formats

application/json, text/json

Sample: 
[
	{
		"SKU": "SKU1",
		"MinWasPrice": "129.9500",
		"MaxWasPrice": "139.9500",
		"MinNowPrice": "69.0000",
		"MaxNowPrice": "79.0000",
		"ItemPricings": [
			{
				"Barcode": "Barcode1",
				"WasPrice": "139.9500",
				"NowPrice": "79.0000"
			},
			{
				"Barcode": "Barcode2",
				"WasPrice": "139.9500",
				"NowPrice": "79.0000"
			},
			{
				"Barcode": "Barcode3",
				"WasPrice": "139.9500",
				"NowPrice": "79.0000"
			},
			{
				"Barcode": "Barcode4",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			},
			{
				"Barcode": "Barcode5",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			},
			{
				"Barcode": "Barcode6",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			},
			{
				"Barcode": "Barcode7",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			}
		]
	},
	{
		"SKU": "SKU2",
		"MinWasPrice": "59.9500",
		"MaxWasPrice": "59.9500",
		"MinNowPrice": "19.0000",
		"MaxNowPrice": "19.0000",
		"ItemPricings": [
			{
				"Barcode": "Barcode8",
				"WasPrice": "59.9500",
				"NowPrice": "19.0000"
			}
		]
	}
]

application/xml, text/xml

Sample: 
<Pricings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<Pricing>
		<SKU>SKU1</SKU>
		<MinWasPrice>129.9500</MinWasPrice>
		<MaxWasPrice>139.9500</MaxWasPrice>
		<MinNowPrice>69.0000</MinNowPrice>
		<MaxNowPrice>79.0000</MaxNowPrice>
		<ItemPricings>
			<ItemPricing>
				<Barcode>Barcode1</Barcode>
				<WasPrice>139.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode2</Barcode>
				<WasPrice>139.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode3</Barcode>
				<WasPrice>139.9500</WasPrice>
			<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode4</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode5</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode6</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode7</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
		</ItemPricings>
	</Pricing>
	<Pricing>
		<SKU>SKU2</SKU>
		<MinWasPrice>59.9500</MinWasPrice>
		<MaxWasPrice>59.9500</MaxWasPrice>
		<MinNowPrice>19.0000</MinNowPrice>
		<MaxNowPrice>19.0000</MaxNowPrice>
		<ItemPricings>
			<ItemPricing>
				<Barcode>Barcode8</Barcode>
				<WasPrice>59.9500</WasPrice>
				<NowPrice>19.0000</NowPrice>
			</ItemPricing>
		</ItemPricings>
	</Pricing>
</Pricings>

Get api/pricing/{identifier}

Request Information

URI Parameters

Name Type Description
identifierstringProduct to retrieve.

Sample: http://[siteurl]/api/pricing/SKU1

Body Parameters

None

Response Information

Resource Description

Name Type Description
SKUstringProduct style code.
MaxNowPricestringMaximum buy now price.
MaxWasPricestringMaximum was price.
MinNowPricestringMinimum buy now price.
MinWasPricestringMinimum was price.
Item PricingsItemPricing[]Product Item Pricings.

Response Formats

application/json, text/json

Sample: 
[
	{
		"SKU": "SKU1",
		"MinWasPrice": "129.9500",
		"MaxWasPrice": "139.9500",
		"MinNowPrice": "69.0000",
		"MaxNowPrice": "79.0000",
		"ItemPricings": [
			{
				"Barcode": "Barcode1",
				"WasPrice": "139.9500",
				"NowPrice": "79.0000"
			},
			{
				"Barcode": "Barcode2",
				"WasPrice": "139.9500",
				"NowPrice": "79.0000"
			},
			{
				"Barcode": "Barcode3",
				"WasPrice": "139.9500",
				"NowPrice": "79.0000"
			},
			{
				"Barcode": "Barcode4",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			},
			{
				"Barcode": "Barcode5",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			},
			{
				"Barcode": "Barcode6",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			},
			{
				"Barcode": "Barcode7",
				"WasPrice": "129.9500",
				"NowPrice": "69.0000"
			}
		]
	}
]

application/xml, text/xml

Sample: 
<Pricings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<Pricing>
		<SKU>SKU1</SKU>
		<MinWasPrice>129.9500</MinWasPrice>
		<MaxWasPrice>139.9500</MaxWasPrice>
		<MinNowPrice>69.0000</MinNowPrice>
		<MaxNowPrice>79.0000</MaxNowPrice>
		<ItemPricings>
			<ItemPricing>
				<Barcode>Barcode1</Barcode>
				<WasPrice>139.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode2</Barcode>
				<WasPrice>139.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode3</Barcode>
				<WasPrice>139.9500</WasPrice>
			<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode4</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode5</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode6</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
			<ItemPricing>
				<Barcode>Barcode7</Barcode>
				<WasPrice>129.9500</WasPrice>
				<NowPrice>69.0000</NowPrice>
			</ItemPricing>
		</ItemPricings>
	</Pricing>
</Pricings>