Catalog

The store's products as it lists them. Public keys work from a browser; private keys also from a server.

GET/productsSearch the store's products GET/products/{key}One product GET/staff/products/{key}One product with what only the store may see (private key)

Search the store's products

GET/products

Public (rm_pub_) or private (rm_prv_) key

A search of the key's own store, best match first, or (with updated_since) the listings changed since a time, oldest change first. Both kinds of key get the public columns; a public key's search cannot match a distributor's item number.

Paging. limit is 1 to 60 (default 20). If more is left, next_cursor is a string; pass it as cursor with the same other parameters. The cursor names a position in a total order, so it survives a catalog rebuild: a row never appears twice and a row that was there is not skipped. To mirror a whole catalog, use updated_since=1970-01-01 and follow next_cursor; later, call again with the time you started that walk.

An empty q with no filter returns no products.

Parameters

Name	In	Type	Description
`q`	query	`string`	Search text, cut to 120 characters. If nothing matches and the last word ends in a plural "s", it is tried once more without it.
`limit`	query	`integer`	Default 20. 1 to 60.
`in_stock`	query	`string`	`1` or `true`: only products in stock.
`category`	query	`string`	A category id. Lists without `q`.
`type`	query	`string`	A type id.
`firearm`	query	`"yes" \| "no"`
`updated_since`	query	`string`	ISO 8601 date or time. Lists the listings changed at or after it, oldest change first, and names those no longer visible in `removed`. Cannot be combined with `q` or the filters.
`cursor`	query	`string`	The `next_cursor` of the previous page. Opaque; do not build or change one. A cursor belongs to the request that produced it; with other parameters it is `bad_cursor`. Up to 2048 characters.

Responses

200A page.

Headers: X-Request-Id, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Field	Type	Description
`query`required	`string`
`total`required	`integer \| null`	Matches for a search. Null for an `updated_since` list.
`products`required	`object[]`
products[].`key`required	`string`
products[].`upc`	`string \| null`
products[].`mfrPart`	`string`
products[].`model`	`string`
products[].`manufacturer`	`string`
products[].`brand`	`string \| null`
products[].`title`required	`string`
products[].`description`	`string`
products[].`features`	`string[]`
products[].`specs`	`object[]`
products[].specs[].`label`	`string`
products[].specs[].`value`	`string`
products[].`images`	`(string (uri))[]`
products[].`category`	`object \| null`
products[].category.`id`	`string`
products[].category.`name`	`string`
products[].`type`	`object \| null`
products[].type.`id`	`string`
products[].type.`name`	`string`
products[].`attrs`	`object`
products[].`firearm`required	`boolean`
products[].`weightOz`	`number \| null`
products[].`dimsIn`	`number[] \| null`	3 to 3 items.
products[].`prop65`	`object \| null`
products[].prop65.`message`	`string`
products[].`casePack`	`object \| null`
products[].casePack.`rounds`	`number`
products[].casePack.`boxes`	`number`
products[].casePack.`roundsPerBox`	`number`
products[].`price`required	`object`	What the price shows. Only `show` carries an amount. A MAP rule or a missing rule removes the amount.
products[].price.`display`required	`"show" \| "cart" \| "contact" \| "signin" \| "none"`
products[].price.`amount`	`number`	Dollars.
products[].`inStock`required	`boolean`
products[].`restrictedStates`	`string[]`
products[].`groundOnly`	`boolean`
products[].`adultSignature`	`boolean`
`removed`	`string[]`	Only with `updated_since`. Products that changed and are no longer visible; drop them from your copy.
`next_cursor`required	`string \| null`	Pass as `cursor` for the next page. Null on the last page.

Errors400401403429503in the error envelope.

Example

Shell
curl "https://app.getrollmark.com/api/v1/products" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

One product

GET/products/{key}

Public (rm_pub_) or private (rm_prv_) key

One product of the key's store, public columns only. Returned only if it is active, not switched off by a brand rule and not hidden from the store.

Parameters

Name	In	Type	Description
`key`required	path	`string`	The product key, URL-encoded (`upc:<upc>` or `mpn:<MAKER>\|<PART>`).

Responses

200The product.

Headers: X-Request-Id

Field	Type	Description
`product`required	`object`
product.`key`required	`string`
product.`upc`	`string \| null`
product.`mfrPart`	`string`
product.`model`	`string`
product.`manufacturer`	`string`
product.`brand`	`string \| null`
product.`title`required	`string`
product.`description`	`string`
product.`features`	`string[]`
product.`specs`	`object[]`
product.specs[].`label`	`string`
product.specs[].`value`	`string`
product.`images`	`(string (uri))[]`
product.`category`	`object \| null`
product.category.`id`	`string`
product.category.`name`	`string`
product.`type`	`object \| null`
product.type.`id`	`string`
product.type.`name`	`string`
product.`attrs`	`object`
product.`firearm`required	`boolean`
product.`weightOz`	`number \| null`
product.`dimsIn`	`number[] \| null`	3 to 3 items.
product.`prop65`	`object \| null`
product.prop65.`message`	`string`
product.`casePack`	`object \| null`
product.casePack.`rounds`	`number`
product.casePack.`boxes`	`number`
product.casePack.`roundsPerBox`	`number`
product.`price`required	`object`	What the price shows. Only `show` carries an amount. A MAP rule or a missing rule removes the amount.
product.price.`display`required	`"show" \| "cart" \| "contact" \| "signin" \| "none"`
product.price.`amount`	`number`	Dollars.
product.`inStock`required	`boolean`
product.`restrictedStates`	`string[]`
product.`groundOnly`	`boolean`
product.`adultSignature`	`boolean`

Errors401403404429503in the error envelope.

Example

Shell
curl "https://app.getrollmark.com/api/v1/products/<key>" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

One product with what only the store may see (private key)

GET/staff/products/{key}

Private key (rm_prv_), from a server

The product with cost, MAP, MSRP, total quantity and the distributors' offers. It does not apply the hidden or inactive filters, so it also answers for a product the store has hidden. A public key gets 403.

Parameters

Name	In	Type	Description
`key`required	path	`string`	The product key, URL-encoded (`upc:<upc>` or `mpn:<MAKER>\|<PART>`).

Responses

200The product with its private columns.

Headers: X-Request-Id

Field	Type	Description
`product`required	`object`
product.`key`required	`string`
product.`upc`	`string \| null`
product.`mfrPart`	`string`
product.`model`	`string`
product.`manufacturer`	`string`
product.`brand`	`string \| null`
product.`title`required	`string`
product.`description`	`string`
product.`features`	`string[]`
product.`specs`	`object[]`
product.specs[].`label`	`string`
product.specs[].`value`	`string`
product.`images`	`(string (uri))[]`
product.`category`	`object \| null`
product.category.`id`	`string`
product.category.`name`	`string`
product.`type`	`object \| null`
product.type.`id`	`string`
product.type.`name`	`string`
product.`attrs`	`object`
product.`firearm`required	`boolean`
product.`weightOz`	`number \| null`
product.`dimsIn`	`number[] \| null`	3 to 3 items.
product.`prop65`	`object \| null`
product.prop65.`message`	`string`
product.`casePack`	`object \| null`
product.casePack.`rounds`	`number`
product.casePack.`boxes`	`number`
product.casePack.`roundsPerBox`	`number`
product.`price`required	`object`	What the price shows. Only `show` carries an amount. A MAP rule or a missing rule removes the amount.
product.price.`display`required	`"show" \| "cart" \| "contact" \| "signin" \| "none"`
product.price.`amount`	`number`	Dollars.
product.`inStock`required	`boolean`
product.`restrictedStates`	`string[]`
product.`groundOnly`	`boolean`
product.`adultSignature`	`boolean`
product.`cost`required	`number \| null`
product.`map`required	`number \| null`
product.`msrp`required	`number \| null`
product.`totalQty`required	`number \| null`
product.`offers`required	`object[]`
product.offers[].`distributor`required	`string`
product.offers[].`sku`required	`string`
product.offers[].`cost`	`string \| null`	The distributor's cost in dollars as a decimal string (for example "51.25"), as the database returns it. The product-level cost, map and msrp are numbers.
product.offers[].`qty`	`number \| null`
product.offers[].`status`	`string \| null`

Errors401403404503in the error envelope.

Example

Shell
curl "https://app.getrollmark.com/api/v1/staff/products/<key>" \
  -H "Authorization: Bearer $ROLLMARK_KEY"