Products

This describes the product resource in the Provet Dropship API.

---

Properties

Name	Type	Description
Code	string	SKU Code of the product
Description	string	Description of the product
FriendlyDescription	string	A friendly description of the product
LongDescription	string	A long HTML description of the product
Teaser	string	A teaser of the product
Price	decimal	The price per item
Rrp	decimal	The recommended retail price
Tags	array of strings	List of product tags
Images	array of strings	List of image URLs
Length	decimal	Length in mm
Breadth	decimal	Breadth in mm
Height	decimal	Height in mm
Weight	decimal	Weight in grams
QuantityOnHand	integer	Quantity on hand at the Provet branch This field is only shown when viewing an individual product

---

List Products

Get a list of products from the product catalogue. Where a product is no longer available it will no longer be returned.
The returned product list is limited to the top 20 products by default, otherwise set the pagination according to the parameters as stated in Overview | Pagination

GET ~/api/products?page=1&pageSize=10

Returns a paginated list of products.

Sample response:

{
	"items": [
		{
			"code": ",HOLI C 1",
			"description": "BOOK - HOLIDAYING WITH CATS",
			"friendlyDescription": "Holidaying With Cats",
			"longDescription": null,
			"teaser": null,
			"price": 11.1,
			"rrp": 14.95,
			"tags": null,
			"images": [
				{
					"url": "/Content/images/products/holic1.jpg"
				}
			],
			"length": 140,
			"breadth": 216,
			"height": 80,
			"weight": 160
		},

		// more products here ...

	],
	"pageNumber": 1,
	"pageSize": 10,
	"count": 10,
	"totalCount": 3079,
	"pageCount": 1540,
	"isFirstPage": true,
	"isLastPage": false,
	"hasPreviousPage": false,
	"hasNextPage": true
}

---

Get a Product

Get a product from the catalogue via the Product Code.

GET /products/{ProductCode}

Parameter	Type	Required	Description
ProductCode	String	True	The Provet product code URL encoded

Returns a 404 - Not Found if the ProductCode is invalid.

Sample response:

{
    "quantityOnHand": 0,
    "code": ",HOLI C 1",
    "description": "BOOK - HOLIDAYING WITH CATS",
    "friendlyDescription": "Holidaying With Cats",
    "longDescription": null,
    "teaser": null,
    "price": 11.1,
    "rrp": 14.95,
    "tags": null,
    "images": [
        {
            "url": "/Content/images/products/holic1.jpg"
        }
    ],
    "length": 140,
    "breadth": 216,
    "height": 80,
    "weight": 160
}