Taffy Dashboard

Resources:

Resource URI Methods
accountMember /account/{UserUUID} get
basketCollection /basket post
basketMember /basket/{sBasketUUID} post|get|delete
basketCompleteMember /basket/{sBasketUUID}/complete post
categoriesCollection /categories get
categoriesMember /categories/{iCategoryID} get
checkEmail /checkEmail get
classicCollection /classic get
classicMember /classic/{sSearchText} get
imageCollection /images get
imageMember /images/{iItemID} get
partNumCollection /partNums get
partCollection /parts get
partMember /parts/{iItemID} get
partPriceCollection /prices get
partPriceMember /prices/{iItemID} get
saleCollection /sale get
searchCollection /search/ get
searchMember /search/{sSearchText} get
vehicleCollection /vehicleTypes get

Implemented Encodings:

imageMember
URI: /images/{iItemID}
Description: Get image data for a given part ID
get Get image details from the database
Required Param Type Default Description
required numeric iItemID Filter results by a single item ID - will return a single record
post Not Allowed
delete Not Allowed
put Not Allowed
categoriesMember
URI: /categories/{iCategoryID}
Description: Get category data
get Get category details from the database
Required Param Type Default Description
optional numeric iCategoryID 0 Category ID
optional numeric iResultsPerPage 20 How many results to show per page - Default: 20
optional numeric iDisplayPage 1 Results page to return - Default: 1
post Not Allowed
delete Not Allowed
put Not Allowed
searchCollection
URI: /search/
Description: Search for parts
get Search the database for item IDs
Required Param Type Default Description
optional string sCollection vwh_search_en_gb Collection to use for this search
optional string sVehicle [empty string] Optional vehicle type filter - Accepts a CSV list of vehicles
optional string sYears [empty string] Optional year filter - Accepts a CSV list of years
optional string sBrand [empty string] Optional brand filter - Accepts a CSV list of brands
optional string sOrigin [empty string] Optional origin filter - Accepts a CSV list of origins
optional string sPartType [empty string] Optional part type filter - Accepts a CSV list of part type codes (B: Bumper | C: Complete bus front panel | E: Engine | F: Front axel | G: Glass | K: Packaging | N: Ordinary part | P: Panel | R: Roof rack | W: Warranty | Y: Bonnet | Z: Gearbox)
optional numeric iMinPrice 0 Optional price filter (minimum)
optional numeric iMaxPrice 9999999999 Optional price filter (maximum)
optional numeric iPriceBand 1 Price band to use for price queries
optional numeric bInstock -1 In stock filter - 1: In stock | 0: Out of stock | -1: All (default)
optional numeric bSaleItem -1 Sale item filter - 1: Sale items | 0: Non-sale items | -1: All (default)
optional numeric bSpecialOrder -1 Special order filter - 1: Special order items | 0: Non special order items | -1: All (default)
optional numeric iResultsPerPage 20 How many results to show per page - Default: 20
optional numeric iDisplayPage 1 Results page to return - Default: 1
optional string sSortBy rank Specify sort order of results - (rank | partNumber | brand | origin | price)
optional string sSortDir DESC Specify sort direction of results (ASC | DSC) - Default: ASC
post Not Allowed
delete Not Allowed
put Not Allowed
classicMember
URI: /classic/{sSearchText}
Description: Search the classic parts database - returns part IDs
get Search the database for classic parts
Required Param Type Default Description
required string sSearchText Text string to search for
optional numeric iResultsPerPage 20 How many results to show per page - Default: 20
optional numeric iDisplayPage 1 Results page to return - Default: 1
optional string sSortBy PART Specify sort order of results - (PART | POP | PRICE) - Default: PART
optional string sSortDir ASC Specify sort direction of results (ASC | DSC) - Default: ASC
post Not Allowed
delete Not Allowed
put Not Allowed
imageCollection
URI: /images
get Get image details
Required Param Type Default Description
required string l_iItemID Filter results by a list of item IDs, accepts a comma seperated list and will return a structure containing images for multiple items
post Not Allowed
delete Not Allowed
put Not Allowed
accountMember
URI: /account/{UserUUID}
Description: Account functionality
get Get account details
Required Param Type Default Description
optional string UserUUID [empty string] Authentication hash
post Not Allowed
delete Not Allowed
put Not Allowed
classicCollection
URI: /classic
Description: Get classic part data - pass an ID, a list of IDs or partcodes, and filters
get Get classic part details from the database
Required Param Type Default Description
optional numeric iItemID 0 Filter results by a single item ID - will return a single record
optional string l_iItemID [empty string] Filter results by a list of item IDs, accepts a comma seperated list and will return multiple records
optional string l_sPartCode [empty string] Filter results by a list of part codes (Part codes must be stripped of hyphens, slashes, spaces and periods), accepts a comma seperated list and will return multiple records
optional numeric bSpecialOrder -1 Filter results by Special Order status: (-1 = All | 0 = Normal items | 1 = Special order items)
optional numeric iMinPrice 0 Filter results with a minimum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric iMaxPrice 0 Filter results with a maximum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric bInStock -1 Filter results by stock level: (-1 = All | 0 = Out of stock items | 1 = In stock items)
optional string l_sPartTypeCode [empty string] Filter results by part type: (B = Bumper | C = Complete Bus Front Panel | E = Engine | F = Front Axel | G = Glass | K = Packaging | N = Ordinary part | P = Panel | R = Roof Rack | W = Warrenty | Y = Bonnet | Z = Gearbox) - Accepts a comma separated list of values
optional string bSaleItem -1 Filter results by Sale status: (-1 = All | n = Normal items | y = Sale items)
post Not Allowed
delete Not Allowed
put Not Allowed
vehicleCollection
URI: /vehicleTypes
get Get vehicle type details from the databse. Results are cached daily.
Required Param Type Default Description
optional boolean bShortList 1 List type: 0 = Return full list | 1 = Return short list for search (default)
post Not Allowed
delete Not Allowed
put Not Allowed
categoriesCollection
URI: /categories
get Get category details from the database
Required Param Type Default Description
optional numeric iPageID 0 Page ID to start from
optional numeric iLevels 0 Number of levels to return
post Not Allowed
delete Not Allowed
put Not Allowed
basketCompleteMember
URI: /basket/{sBasketUUID}/complete
Description: Mark a basket as completed
post Accepts a basket UUID (If basket exists) and marks the basket as completed
Required Param Type Default Description
optional string sBasketUUID [empty string] Unique identifier for basket
get Not Allowed
delete Not Allowed
put Not Allowed
partCollection
URI: /parts
get Get part details from the database
Required Param Type Default Description
optional numeric iItemID 0 Filter results by a single item ID - will return a single record
optional string l_iItemID [empty string] Filter results by a list of item IDs, accepts a comma seperated list and will return multiple records
optional string l_sPartCode [empty string] Filter results by a list of part codes (Part codes must be stripped of hyphens, slashes, spaces and periods), accepts a comma seperated list and will return multiple records
optional numeric bSpecialOrder -1 Filter results by Special Order status: (-1 = All | 0 = Normal items | 1 = Special order items)
optional numeric iMinPrice 0 Filter results with a minimum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric iMaxPrice 0 Filter results with a maximum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric bInStock -1 Filter results by stock level: (-1 = All | 0 = Out of stock items | 1 = In stock items)
optional string l_sPartTypeCode [empty string] Filter results by part type: (B = Bumper | C = Complete Bus Front Panel | E = Engine | F = Front Axel | G = Glass | K = Packaging | N = Ordinary part | P = Panel | R = Roof Rack | W = Warrenty | Y = Bonnet | Z = Gearbox) - Accepts a comma separated list of values
optional string bSaleItem -1 Filter results by Sale status: (-1 = All | n = Normal items | y = Sale items)
optional string sCountryCode GB Return country specific results: (GB | DE)
post Not Allowed
delete Not Allowed
put Not Allowed
partMember
URI: /parts/{iItemID}
Description: Get part data
get Get part details from the database
Required Param Type Default Description
required numeric iItemID Filter results by a single item ID - will return a single record
optional string sCountryCode GB Return country specific results: (GB | DE)
post Not Allowed
delete Not Allowed
put Not Allowed
partPriceCollection
URI: /prices
Description: Get the correct price data for a colleciton of parts
get Get part details from the database
Required Param Type Default Description
optional string l_iItemID [empty string] Filter results by a list of item IDs, accepts a comma seperated list and will return multiple records
optional string UserUUID [empty string] User UUID - prices returned will be specific to the user passed.
optional string sCountryCode GB Return country specific results: (GB | DE)
post Not Allowed
delete Not Allowed
put Not Allowed
basketCollection
URI: /basket
Description: Basket functionality
post Accpets an item ID, quantity and basket UUID (If basket exists) and updates the basket accordingly
Required Param Type Default Description
optional string sBasketUUID [empty string] Unique identifier for basket
required numeric iItemID Item ID
optional numeric iQuantity 1 Quantity
optional boolean bOverwriteQuantity no When adding another instance of an existing item to the cart, you would usually expect the quantity to be added. However if this function is being called from a cart page, you may want to overwrite the quantity with a new figure. Set this flag to overwrite the existing quantity.
get Not Allowed
delete Not Allowed
put Not Allowed
checkEmail
URI: /checkEmail
Description: Check email address exists in user profiles - Must pass a URL encoded email address
get Check email address
Required Param Type Default Description
optional string email [empty string] Email Address
post Not Allowed
delete Not Allowed
put Not Allowed
saleCollection
URI: /sale
Description: Get sale product data
get Get sale product details from the database
Required Param Type Default Description
optional numeric iResultsPerPage 20 How many results to show per page - Default: 20
optional numeric iDisplayPage 1 Results page to return - Default: 1
optional numeric bSpecialOrder -1 Filter results by Special Order status: (-1 = All | 0 = Normal items | 1 = Special order items)
optional numeric iMinPrice 0 Filter results with a minimum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric iMaxPrice 0 Filter results with a maximum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric bInStock -1 Filter results by stock level: (-1 = All | 0 = Out of stock items | 1 = In stock items)
optional string l_sPartTypeCode [empty string] Filter results by part type: (B = Bumper | C = Complete Bus Front Panel | E = Engine | F = Front Axel | G = Glass | K = Packaging | N = Ordinary part | P = Panel | R = Roof Rack | W = Warrenty | Y = Bonnet | Z = Gearbox) - Accepts a comma separated list of values
post Not Allowed
delete Not Allowed
put Not Allowed
partPriceMember
URI: /prices/{iItemID}
Description: Get the correct price data for a part
get Get part details from the database
Required Param Type Default Description
required numeric iItemID Item ID - will return a single record
optional string UserUUID [empty string] User UUID - prices returned will be specific to the user passed.
optional string sCountryCode GB Return country specific results: (GB | DE)
post Not Allowed
delete Not Allowed
put Not Allowed
partNumCollection
URI: /partNums
get Get part numbers and ID's from the database
Required Param Type Default Description
optional numeric iItemID 0 Filter results by a single item ID - will return a single record
optional string l_iItemID [empty string] Filter results by a list of item IDs, accepts a comma seperated list and will return multiple records
optional string l_sPartCode [empty string] Filter results by a list of part codes (Part codes must be stripped of hyphens, slashes, spaces and periods), accepts a comma seperated list and will return multiple records
optional numeric bSpecialOrder -1 Filter results by Special Order status: (-1 = All | 0 = Normal items | 1 = Special order items)
optional numeric iMinPrice 0 Filter results with a minimum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric iMaxPrice 0 Filter results with a maximum price - accepts an integer, prices should be in pennies, so £1 would be '100'
optional numeric bInStock -1 Filter results by stock level: (-1 = All | 0 = Out of stock items | 1 = In stock items)
optional string l_sPartTypeCode [empty string] Filter results by part type: (B = Bumper | C = Complete Bus Front Panel | E = Engine | F = Front Axel | G = Glass | K = Packaging | N = Ordinary part | P = Panel | R = Roof Rack | W = Warrenty | Y = Bonnet | Z = Gearbox) - Accepts a comma separated list of values
optional string bSaleItem -1 Filter results by Sale status: (-1 = All | n = Normal items | y = Sale items)
post Not Allowed
delete Not Allowed
put Not Allowed
basketMember
URI: /basket/{sBasketUUID}
Description: Basket functionality
get Get basket details from the database
Required Param Type Default Description
optional string sBasketUUID [empty string] Unique identifier for basket
delete Requires a Basket UUID and a basket line ID and removes the line from the basket
Required Param Type Default Description
optional string sBasketUUID [empty string] Unique identifier for basket
required numeric iBasketLineID Basket line ID
post Accpets an item ID, quantity and basket UUID (If basket exists) and updates the basket accordingly
Required Param Type Default Description
optional string sBasketUUID [empty string] Unique identifier for basket
required numeric iItemID Item ID
optional numeric iQuantity 1 Quantity
optional boolean bOverwriteQuantity no When adding another instance of an existing item to the cart, you would usually expect the quantity to be added. However if this function is being called from a cart page, you may want to overwrite the quantity with a new figure. Set this flag to overwrite the existing quantity.
put Not Allowed
searchMember
URI: /search/{sSearchText}
Description: Search for parts
get Search the database for item IDs
Required Param Type Default Description
optional string sCollection vwh_search_en_gb Collection to use for this search
optional string sSearchText [empty string] Text string to search for
optional string sVehicle [empty string] Optional vehicle type filter - Accepts a CSV list of vehicles
optional string sYears [empty string] Optional year filter - Accepts a CSV list of years
optional string sBrand [empty string] Optional brand filter - Accepts a CSV list of brands
optional string sOrigin [empty string] Optional origin filter - Accepts a CSV list of origins
optional string sPartType [empty string] Optional part type filter - Accepts a CSV list of part type codes (B: Bumper | C: Complete bus front panel | E: Engine | F: Front axel | G: Glass | K: Packaging | N: Ordinary part | P: Panel | R: Roof rack | W: Warranty | Y: Bonnet | Z: Gearbox)
optional numeric iMinPrice 0 Optional price filter (minimum)
optional numeric iMaxPrice 9999999999 Optional price filter (maximum)
optional numeric iPriceBand 1 Price band to use for price queries
optional numeric bInstock -1 In stock filter - 1: In stock | 0: Out of stock | -1: All (default)
optional numeric bSaleItem -1 Sale item filter - 1: Sale items | 0: Non-sale items | -1: All (default)
optional numeric bSpecialOrder -1 Special order filter - 1: Special order items | 0: Non special order items | -1: All (default)
optional numeric iResultsPerPage 20 How many results to show per page - Default: 20
optional numeric iDisplayPage 1 Results page to return - Default: 1
optional string sSortBy rank Specify sort order of results - (rank | partNumber | brand | origin | price)
optional string sSortDir DESC Specify sort direction of results (ASC | DSC) - Default: ASC
post Not Allowed
delete Not Allowed
put Not Allowed