Item Pricing API

Overview

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

Purpose

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

Endpoint

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

This endpoint is enabled for access via HTTP GET.

GET api/itempricing

Request Information

URI Parameters

Name Type Description
identifiersstringArray of items to retrieve.

Sample: http://[siteurl]/api/itempricing/?identifiers=item1&identifiers=item2&identifiers=item3

Body Parameters

None

Response Information

Resource Description

Name Type Description
BarcodestringProduct item code.
NowPricestringBuy now price.
WasPricestringWas price.

Response Formats

application/json, text/json

Sample:
[
	{
		"Barcode":"barcode1",
		"NowPrice":"189.0000",
		"WasPrice":"229.0000"
	},
	{
		"Barcode":"barcode2",
		"NowPrice":"229.0000",
		"WasPrice":"229.0000"
	}
]
						

application/xml, text/xml

Sample:
<ItemPricings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<ItemPricing>
		<Barcode>barcode1</Barcode>
		<WasPrice>189.0000</WasPrice>
		<NowPrice>229.0000</NowPrice>
	</ItemPricing>
	<ItemPricing>
		<Barcode>barcode2</Barcode>
		<WasPrice>229.0000</WasPrice>
		<NowPrice>229.0000</NowPrice>
	</ItemPricing>
</ItemPricings>
						

GET api/itempricing/{identifier}

Request Information

URI Parameters

Name Type Description
identifierstringItem to retrieve.

Sample: http://[siteurl]/api/itempricing/barcode1

Body Parameters

None

Response Information

Resource Description

Name Type Description
BarcodestringProduct item code.
NowPricestringBuy now price.
WasPricestringWas price.

Response Formats

application/json, text/json

Sample:
[
	{
		"Barcode":"barcode1",
		"NowPrice":"189.0000",
		"WasPrice":"229.0000"
	}
]
						

application/xml, text/xml

Sample:
<ItemPricings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<ItemPricing>
		<Barcode>barcode1</Barcode>
		<WasPrice>189.0000</WasPrice>
		<NowPrice>229.0000</NowPrice>
	</Pricing>
</Pricings>