Items API
This API is for pulling items from your Punchmark website based on specific filter parameters.
Filter parameters can range from category to stone types and are listed below.
Base URL
https://www.{domain}/api/fetch/grid/fetch/get_results?readonly=1&catOrBrand=catFirst&{filters}Filters
Filters are appended as query string parameters to the base item API URL. They follow the format key=value. Some filters accept specific IDs as values, others string values, and others allow ranges.
The full list is below.
availability: Number of days until product is available
brand: Brand URL (pull from brand list)
categories: List of categories (pull from brand list)
category: ID of category (pull from category list)
catOrBrand: (“catFirst” or “brandFirst”) Determines whether we’re looking at a brand inside a category or a category inside a brand. Functionally, almost identical: can always be “catFirst” for simplicity.
collection: Pull products by "collection" field. Literal value.
diamondweight: Range separated by dash
gender: Literal, based on value from products (mens, womens, childrens)
gemstone: Use gemstone type ID (pull from gemstone list)
inStock: Whether product is in stock now
is: alternate for In_Stock: only products that originated from point of sale or inventory software
itemTag: return products by tag (mother's day, etc)
itemsPerPage: defaults to 24, max 200
kw: Search keyword, url encoded
length: literal numeric value
line: product line ID (prefer brand filter)
material: metal type (from list of valid metal abbreviations)
pageNum: page number, based on Items_Per_Page parameter
price: price range separated by '-'
settingType: comma separated list of setting type IDs (pull from setting type list)
shipsToday: In_Stock and retail>0 (purchasable and available)
showAll: true or unset. Prefer Items_Per_Page for performance reasons
sortSpec: Sort order: "featured" (manually sorted), "ctime" (newest), "lo2hi", "hi2lo", "popularity"
specials: Only show discounted products
stoneShape: Comma separated list of stone shape IDs (pull from stone shape list)
style: literal style value from style field (art deco, pave, etc)
subcategory: SubCategory ID. Requires Category for sanity check.
width: Literal Width value or range [To] [From]
Examples
Pull page 1 of a subcategory
https://www.{domain}/api/fetch/grid/fetch/get_results?readonly=1&catOrBrand=catFirst&category=173&subcategory=319Pull page 2 of Stuller branded products within category 27 sorted newest first
https://www.{domain}/api/fetch/grid/fetch/get_results?readonly=1&catOrBrand=catFirst&category=27&brand=stuller&materials=14KW&pageNum=2&sortSpec=newestAllowed Values
See here for lists of valid values:
Category List (Use categoryID)
https://www.{domain}/api/async/widgetFeed/lists/get_cat_listBrand List (Use collectionURL)
https://www.braxjewelers.com/api/async/widgetFeed/lists/get_brand_list