Query All Product Catalogs

Introduction

This operation queries all product catalog summaries.

Method

Service Name

Service Type

GET

productCatalogManagement/v1/productCatalogs

Synchronous

URI: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalogs

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.

Name

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

There are no request elements for this service call.

To call this service use the following URI: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalogs

Response Elements

The following elements are returned in the response.

Name

Description

Type

productCatalogSummaryList

List of product catalog summary

List

total

The total number of product catalog summaries existing in the system

Integer

Product Catalog Summary List

Name

Description

Type

Max Length

Mandatory

version

The version of product catalog

Integer

Y

name

The name of the product catalog

String

255

Y

Error Codes

HTTP Status Code

Error Code

Description

403

query.all.product.catalogs.by.product.unauthorized

Not authorized

Sample Request and Response

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

GET /productCatalogManagement/v1/productCatalogs HTTP/1.1
User-Agent: curl/7.23.1 (x86_64-pc-win32) libcurl/7.23.1 OpenSSL/0.9.8r zlib/1.2.5
Host: api.blackhawknetwork.com
Accept: */*
requestorId: CLMMVC5PQRRYHGZCG6LX47Z6T8
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 08 Oct 2012 06:55:52 GMT
Content-Length: 569
{
   "results":[
      {
         "entityId":"http://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/BM3TNCWAKXD6ADBS7RNPLK7MNH",
         "name":"WRAPP Product Catalog",
         "version":1
      }
   ],
   "total":1
}

Did this page help you?