Product Prices

The ProductPrices resource allows the product prices to be listed and viewed. An individual product price can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.

The full range of URIs and HTTP verbs supported are:

Operation	HTTP Action
List a page of Product Prices	GET `/ProductPrices`
View a Product Price with the specified Guid	GET `/ProductPrices/{productPriceGuid}`

GET ProductPrices

Available Filters for GET ProductPrices

Filter	Description
`asAtDate`	Returns product prices for a specific date.
`customerCode`	Returns product prices matching the specified customer code.
`modifiedSince`	Returns product prices modified since the specified date.
`productCode`	Returns product prices matching the specified product code.
`productGroupPrices`	Returns ONLY product group prices for the specified product group. The product code and product description will not be displayed. Does not work for sub groups.

Available Fields for GET ProductPrices

Property	Type	Length	Notes
Comments	String	1024
Customer	Customer
Customer Price	Decimal
Default Sell Price	Decimal
Discount Value	Decimal
Minimum Quantity	Decimal
Price Type	String
Product	Product
Product Group	Product Group		Will not return sub groups.
Valid From	DateTime
Valid To	DateTime

Available Fields for Product

Property	Type	Length	Notes
Guid	Guid		Unique identifier. Can only be set when adding a record.
ProductCode	String	100
ProductDescription	String	500

Available Fields for Product Group

Note: Only returns parent Product Groups, sub groups will not be returned.

Property	Type	Length	Notes
GroupName	String	450
Guid	Guid		Unique identifier. Can only be set when adding a record.
LastModifiedOn	Nullable DateTime

Available Fields for Customer

Property	Type	Length	Notes
CustomerCode	String	500
CustomerName	String	500
Guid	Guid		Unique identifier. Can only be set when adding a record.
LastModifiedOn	Nullable DateTime

Examples for Response GET `/ProductPrices`

show xml example

 
<?xml version="1.0"?>
<ProductPrices xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
    <Pagination>
        <NumberOfItems>4</NumberOfItems>
        <PageSize>200</PageSize>
        <PageNumber>1</PageNumber>
        <NumberOfPages>1</NumberOfPages>
    </Pagination>
    <ProductPrice>
        <Guid>f3cc48a8-2555-465b-808a-d966878b6563</Guid>
        <LastModifiedOn>2017-11-19T21:49:09.6425182</LastModifiedOn>
        <Product>
            <Guid>a22ae102-3c6e-467e-b6a3-ba18b48a8343</Guid>
            <ProductCode>CHAIR</ProductCode>
            <ProductDescription>Lounge Chair</ProductDescription>
        </Product>
        <ProductGroup>
            <Guid>99629a5c-a9b2-492c-9ba2-0c228fd05053</Guid>
            <LastModifiedOn>2015-11-17T03:33:51.9866667</LastModifiedOn>
            <GroupName>Furniture</GroupName>
        </ProductGroup>
        <Customer>
            <Guid>5e0eb0ba-ea60-4344-9eed-4415505ebb6a</Guid>
            <LastModifiedOn>2017-11-19T21:49:11.9393979</LastModifiedOn>
            <CustomerCode>BENEMP</CustomerCode>
            <CustomerName>Ben's Emporium</CustomerName>
        </Customer>
        <PriceType>Fixed Price</PriceType>
        <DiscountValue>900.0000</DiscountValue>
        <MinimumQuantity xsi:nil="true" />
        <DefaultSellPrice>999.0000</DefaultSellPrice>
        <CustomerPrice>900.0000</CustomerPrice>
        <ValidFrom>2017-11-01T00:00:00</ValidFrom>
        <ValidTo>2017-12-31T00:00:00</ValidTo>
        <Comments>Special Deal</Comments>
    </ProductPrice>
    <ProductPrice>
        <Guid>1e42a862-7076-4f0c-a6b5-6a160dcf2ecb</Guid>
        <LastModifiedOn>2017-11-19T21:47:35.0329662</LastModifiedOn>
        <Product>
            <Guid>a22ae102-3c6e-467e-b6a3-ba18b48a8343</Guid>
            <ProductCode>CHAIR</ProductCode>
            <ProductDescription>Lounge Chair</ProductDescription>
        </Product>
        <ProductGroup>
            <Guid>99629a5c-a9b2-492c-9ba2-0c228fd05053</Guid>
            <LastModifiedOn>2015-11-17T03:33:51.9866667</LastModifiedOn>
            <GroupName>Furniture</GroupName>
        </ProductGroup>
        <PriceType>Fixed Price</PriceType>
        <DiscountValue>995.0000</DiscountValue>
        <MinimumQuantity>10.0000</MinimumQuantity>
        <DefaultSellPrice>999.0000</DefaultSellPrice>
        <CustomerPrice>995.0000</CustomerPrice>
        <ValidFrom xsi:nil="true" />
        <ValidTo xsi:nil="true" />
    </ProductPrice>
    <ProductPrice>
        <Guid>b884dae1-4c9e-4f7b-8eae-43523b2d356e</Guid>
        <LastModifiedOn>2017-11-19T21:47:11.7047898</LastModifiedOn>
        <Product>
            <Guid>a22ae102-3c6e-467e-b6a3-ba18b48a8343</Guid>
            <ProductCode>CHAIR</ProductCode>
            <ProductDescription>Lounge Chair</ProductDescription>
        </Product>
        <ProductGroup>
            <Guid>99629a5c-a9b2-492c-9ba2-0c228fd05053</Guid>
            <LastModifiedOn>2015-11-17T03:33:51.9866667</LastModifiedOn>
            <GroupName>Furniture</GroupName>
        </ProductGroup>
        <PriceType>Discount %</PriceType>
        <DiscountValue>0.2500</DiscountValue>
        <MinimumQuantity>10.0000</MinimumQuantity>
        <DefaultSellPrice>999.0000</DefaultSellPrice>
        <CustomerPrice>749.2500</CustomerPrice>
        <ValidFrom>2017-12-01T00:00:00</ValidFrom>
        <ValidTo>2018-01-31T00:00:00</ValidTo>
        <Comments>Christmas Promo</Comments>
    </ProductPrice>
    <ProductPrice>
        <Guid>5c510e57-70d8-442c-b4cf-f4fc1f56a882</Guid>
        <LastModifiedOn>2017-11-19T21:46:37.2359698</LastModifiedOn>
        <Product>
            <Guid>a22ae102-3c6e-467e-b6a3-ba18b48a8343</Guid>
            <ProductCode>CHAIR</ProductCode>
            <ProductDescription>Lounge Chair</ProductDescription>
        </Product>
        <ProductGroup>
            <Guid>99629a5c-a9b2-492c-9ba2-0c228fd05053</Guid>
            <LastModifiedOn>2015-11-17T03:33:51.9866667</LastModifiedOn>
            <GroupName>Furniture</GroupName>
        </ProductGroup>
        <PriceType>Discount %</PriceType>
        <DiscountValue>0.2000</DiscountValue>
        <MinimumQuantity>100.0000</MinimumQuantity>
        <DefaultSellPrice>999.0000</DefaultSellPrice>
        <CustomerPrice>799.2000</CustomerPrice>
        <ValidFrom>2017-11-01T00:00:00</ValidFrom>
        <ValidTo>2017-11-30T00:00:00</ValidTo>
    </ProductPrice>
</ProductPrices>

show json example

{
    "Pagination": {
        "NumberOfItems": 4,
        "PageSize": 200,
        "PageNumber": 1,
        "NumberOfPages": 1
    },
    "Items": [
        {
            "Product": {
                "Guid": "a22ae102-3c6e-467e-b6a3-ba18b48a8343",
                "ProductCode": "CHAIR",
                "ProductDescription": "Lounge Chair"
            },
            "ProductGroup": {
                "GroupName": "Furniture",
                "Guid": "99629a5c-a9b2-492c-9ba2-0c228fd05053",
                "LastModifiedOn": "/Date(1447731231986)/"
            },
            "Customer": {
                "CustomerCode": "BENEMP",
                "CustomerName": "Ben's Emporium",
                "CurrencyId": 110,
                "Guid": "5e0eb0ba-ea60-4344-9eed-4415505ebb6a",
                "LastModifiedOn": "/Date(1511128151939)/"
            },
            "PriceType": "Fixed Price",
            "DiscountValue": 900,
            "MinimumQuantity": null,
            "DefaultSellPrice": 999,
            "CustomerPrice": 900,
            "ValidFrom": "/Date(1509494400000)/",
            "ValidTo": "/Date(1514678400000)/",
            "Comments": "Special Deal",
            "Guid": "f3cc48a8-2555-465b-808a-d966878b6563",
            "LastModifiedOn": "/Date(1511128149642)/"
        },
        {
            "Product": {
                "Guid": "a22ae102-3c6e-467e-b6a3-ba18b48a8343",
                "ProductCode": "CHAIR",
                "ProductDescription": "Lounge Chair"
            },
            "ProductGroup": {
                "GroupName": "Furniture",
                "Guid": "99629a5c-a9b2-492c-9ba2-0c228fd05053",
                "LastModifiedOn": "/Date(1447731231986)/"
            },
            "Customer": null,
            "PriceType": "Fixed Price",
            "DiscountValue": 995,
            "MinimumQuantity": 10,
            "DefaultSellPrice": 999,
            "CustomerPrice": 995,
            "ValidFrom": null,
            "ValidTo": null,
            "Comments": null,
            "Guid": "1e42a862-7076-4f0c-a6b5-6a160dcf2ecb",
            "LastModifiedOn": "/Date(1511128055032)/"
        },
        {
            "Product": {
                "Guid": "a22ae102-3c6e-467e-b6a3-ba18b48a8343",
                "ProductCode": "CHAIR",
                "ProductDescription": "Lounge Chair"
            },
            "ProductGroup": {
                "GroupName": "Furniture",
                "Guid": "99629a5c-a9b2-492c-9ba2-0c228fd05053",
                "LastModifiedOn": "/Date(1447731231986)/"
            },
            "Customer": null,
            "PriceType": "Discount %",
            "DiscountValue": 0.25,
            "MinimumQuantity": 10,
            "DefaultSellPrice": 999,
            "CustomerPrice": 749.25,
            "ValidFrom": "/Date(1512086400000)/",
            "ValidTo": "/Date(1517356800000)/",
            "Comments": "Christmas Promo",
            "Guid": "b884dae1-4c9e-4f7b-8eae-43523b2d356e",
            "LastModifiedOn": "/Date(1511128031704)/"
        },
        {
            "Product": {
                "Guid": "a22ae102-3c6e-467e-b6a3-ba18b48a8343",
                "ProductCode": "CHAIR",
                "ProductDescription": "Lounge Chair"
            },
            "ProductGroup": {
                "GroupName": "Furniture",
                "Guid": "99629a5c-a9b2-492c-9ba2-0c228fd05053",
                "LastModifiedOn": "/Date(1447731231986)/"
            },
            "Customer": null,
            "PriceType": "Discount %",
            "DiscountValue": 0.2,
            "MinimumQuantity": 100,
            "DefaultSellPrice": 999,
            "CustomerPrice": 799.2,
            "ValidFrom": "/Date(1509494400000)/",
            "ValidTo": "/Date(1512000000000)/",
            "Comments": null,
            "Guid": "5c510e57-70d8-442c-b4cf-f4fc1f56a882",
            "LastModifiedOn": "/Date(1511127997235)/"
        }
    ]
}

Examples for Response GET `/ProductPrices?productGroupPrices=Furniture`