Get Catalog Details

get

https://api-sandbox.blackhawknetwork.com/v1/catalogs/default

Retrieve catalog details based on your default catalog. Product attribute filters are also supported

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageNumber

integer

Page number of the products that are requested (not required)

pageSize

integer

Number of products Per Page (not required)

name

string

Filter by product name. Fuzzy search supported

productId

string

Filter by productId

productLine

string

Filter by name of productLine (brand)

productCategory

string

Filter by product category name

productType

string

Filter by productType.

provisionType

string

Filter by provisionType

maxAmount

string

Filter by maxAmount

locale

string

Filter by locale

promoCode

string

Filter by promoCode

isActive

string

Filter by isActive/ whether promo is active

isVariable

string

Filter by isVariable/ whether it is variable

isRedemptionLimitReached

string

Filter by isRedemptionLimitReached, whether redemption limit has been reached

isBudgetExhausted

string

Filter by isBudgetExhausted, whether budget has been exhausted

locales

string

Filter by locales

Headers

htmlEncode

boolean

need html encoding for some product attributes

Responses

401

Unauthorized

403

Forbidden: Access Denied

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK