---
title: Items API
description: 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…
---

[Skip to content](https://help.punchmark.com/knowledgebase/wiki/spaces/punchmark/pages/2694348803#main-content)

English

Show submenu for translations

[![punchmark-logo-horizontal-white](https://help.punchmark.com/hs-fs/hubfs/Punchmark%20Branding/punchmark-logo-horizontal-white.png?width=225&height=38&name=punchmark-logo-horizontal-white.png)](https://academy.punchmark.com/knowledge?hsLang=en)

- [Website](https://www.punchmark.com/)
- [News](https://www.punchmark.com/news)
- [Support](https://www.punchmark.com/contact-support)
- [In the Loupe](https://www.punchmark.com/loupe)

Open main navigation

Close main navigation

- [Website](https://www.punchmark.com/)
- [News](https://www.punchmark.com/news)
- [Support](https://www.punchmark.com/contact-support)
- [In the Loupe](https://www.punchmark.com/loupe)
- English
  
  Show submenu for translations
- Go to punchmark.com

 Go to punchmark.com

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Punchmark Knowledge Base](https://help.punchmark.com/knowledgebase?hsLang=en)
2. [Data & APIs](https://help.punchmark.com/knowledgebase/data-apis?hsLang=en)
3. [APIs](https://help.punchmark.com/knowledgebase/data-apis?hsLang=en#apis)

# 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=319
```

Pull 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=newest
```

## Allowed Values

### See here for lists of valid values:

[https://punchmark.atlassian.net/wiki/spaces/PUNCHMARK/pages/1299972097/Old+Product+Importer+API#Valid-Values](https://help.punchmark.com/knowledge/wiki/spaces/punchmark/pages/1299972097?hsLang=en)

### Category List (Use categoryID)

```
https://www.{domain}/api/async/widgetFeed/lists/get_cat_list
```

### Brand List (Use collectionURL)

```
https://www.braxjewelers.com/api/async/widgetFeed/lists/get_brand_list
```

- [Default HubSpot Blog](https://blog.punchmark.com/blog)

[![pm-symbol-blue](https://help.punchmark.com/hs-fs/hubfs/Punchmark%20Branding/pm-symbol-blue.png?width=40&height=45&name=pm-symbol-blue.png "pm-symbol-blue")](https://academy.punchmark.com/knowledge?hsLang=en)

Punchmark Resource Center

<https://www.facebook.com/punchmark> <https://www.instagram.com/punchmarkwebsites/> <https://open.spotify.com/show/1IBgfY1m1GIDkkF5N8Dn8F?go=1&sp_cid=0869f391274eb7a313244a8b2a29e059&utm_source=embed_player_p&utm_medium=desktop&nd=1&dlsi=44933130a20a4bcc>

Copyright © 2026, Punchmark