Read Product Catalog

Introduction

This operation reads product catalog information based on a specified product catalog identifier.

Method

Service Name

Service Type

GET

productCatalogManagement/v1/productCatalog

Synchronous

URI: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/{productCatalogId}

Request Header Attributes

Note that all three of the header attributes are optional; however, if you want idempotency support then you should specify all three on every request.

Parameter

Description

Type

Required

requestorId

A value defined by the client application that can be used to uniquely identify that client application. If the client application does not specify a value, a globally unique identifier will be filled in automatically.

String

N

requestId

A value defined by the client application that can be used to uniquely identify that specific request from the client. This value should be set if the client application wants to take advantage of an idempotent operation on a service.

String

N

previousAttempts

The number of times this same request has been attempted unsuccessfully before. A value that is greater than zero will cause the service to view this request as a retry attempt and it will be treated idempotently.

Integer

N

In our example we will be sending the following values in the header:

Content-Type: application/json
requestorId: 1234
requestId: 2019-06-12T15:35:28-0500
previousAttempts: 0

Request Elements

Since this is a get request the request elements need to be sent in the URL itself: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/{productCatalogId}

The following parameters are available:

Name

Description

Type

Required

catalogId

The internal identifier of the product catalog

String

Y

For example: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/TWD0B2FLAGQ9KV6S9AY8NFJJJR

Response Elements

The following elements are returned in the response.

Name

Description

Type

productCatalog

Retrieves the productCatalog for the given catalogId

Integer

The Product Catalog Entity

The product catalog entity contains the following information:

Name

Description

Type

Max Length

Required

entityId

A reference to the URI for the product catalog

URI

255

N

summary

The ProductCatalogSummary entity

Entity

Y

details

The ProductCatalogDetails entity

Entity

N

The Product Catalog Summary Entity

The product catalog summary entity contains the following information:

Name

Description

Type

Max Length

Required

version

The version of product catalog

Integer

Y

name

The name of the product catalog

String

255

Y

The Product Catalog Details Entity

The product catalog details entity contains the following information:

Name

Description

Type

Max Length

Required

creatorId

A reference to the URI for the person that created the entity

URI

255

N

updaterId

A reference to the URI for the person that last updated the entity

URI

255

N

notes

Any notes associated with the last update of the entity

String

255

N

createdTimestamp

Date and time (UTC) at which the entity was created

Date

N

updatedTimestamp

Date and time (UTC) at which the entity was last updated

Date

N

productIds

Set of references to the URIs for the products that belong to this product catalog

Set

Y

description

Description of product catalog

String

255

N

Error Codes

HTTP Status Code

Error Code

Description

404

attempt.to.retrieve.nonexistent.entity

Nonexistent entity

Sample Request and Response

Click on the tabs below to see a sample GET request and the sample JSON response.

GET https://apipp.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/YGSAFLR45SQPAHWDJLBK337H3H HTTP/1.1
Accept-Encoding: gzip,deflate
tenantId: 8YQ1LV7VW3J88DQFNJ0VNX8NG4
certificateId: 8YQ1LV7VW3J88DQFNJ0VNX8NG4
requestorId: 8YQ1LV7VW3J88DQFNJ0VNX8NG4
Host: apipp.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
{
 "entityId": "https://apipp.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/YGSAFLR45SQPAHWDJLBK337H3H",
 "summary": {
 "entityId": "https://apipp.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/YGSAFLR45SQPAHWDJLBK337H3H",
 "name": "Test01 Product Catalog - test eGift",
 "version": 13
 },
 "details": {
 "creatorId": "FWVJKCH8TM6V284GM2RC8QR3FC",
 "updaterId": "13QFT3PGJK49VXN68XW7H6VC2M",
 "createdTimestamp": "2013-03-21T11:33:44.948+0000",
 "updatedTimestamp": "2014-11-10T18:08:33.306+0000",
 "additionalAttributes": [],
 "description": "Product Catalog for BHNTest",
 "productIds": [
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/J3JS9XPXRKN06JZXWYM1STA3W4",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/3A7AMX00BD8PJ9B3432FC1QLM8",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/FSPX6W9GL6TBTT5CV3V9BPFSLM",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/TTG9NMWZ8Y9ZRYWFVQ73S88TF8",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/T3AC34THAZANAKH40MT1V9SC6R",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/QQ0W97ZPYLLWGTGGAP2MQYK5JC",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/PZJ4L81NSD1FXQX1K2A7Z0LMMC",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/S68KVDLK38D98V816DSHRD49X8",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/Y161H44XVC0F8GXSPNBZGDS2AM",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/CYLC5NLZ4XH47VSJYN9W6GT2A4",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/5PAWGT3MLPPVLAG15YA3FFFWAC",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/5HW1C2X4X9BC6RX9MK8NSZWDXW",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/HG2QTZ65GP3A54SCAPPD8T4SPM",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/GKM4K5N75F76B9KPSJK23PJXK4",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/2AK0A1LQAML5DL4C53LN462Z6M",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/889FNGBCD57G0PH0WZQ843J1FM",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/F4L6QXM7FDG167SCA1M75NZ728",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/XZ2G6WR10K45VFV0R59WTD2LBW",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/0XGDF43DLJQQ5VJT4MV6QHF1TR",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/JB3JRH34DRWW0QD91VZNL9WM04",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/MTBPAQSFVCVWAX98MVAB514Y8H",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/305G9D7A106FVWB2LPJD5TPTQC",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/NKPVS2WBBQFQJ93TLN4FRD3RB4",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/R88JQP3GGRH29D2AACM4GMDCLR",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/M8PT4VY8V2BCRRVWZ8AQ0G7QY0",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/10P5BFP5H9V7T0Y00TQSV33AY4",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/MA7Y94DCVH66PF6X4PHVQR5FV8",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/5N4R72WRFVX5F09FH2F36CZ5CM",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/8AF92RH8WXBV1RF53179D0PFN4",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/BDHZG5R0ZNWP0LGK5RS6J4QL10",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/54F11PAW81R08NPK34WSGJ8A8W",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/CBRYQRP1KKP97Z5PY54YK38JXH",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/WVDF913SNSCQP97991VBT5H05R",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/5AKTV4GY6H7HAYHFM67KLVK6Z8",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/4V52SNGD0ZVMAV3CF2VFZPL1GC",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/2PCQ89VGDYZ3WF3M9L4H6SM68H",
 "https://apipp.blackhawknetwork.com/productManagement/v1/product/0X2MH9X9CHQGLGT2ZK8D49NQ3M"
 ]
 }
}

Did this page help you?