Get Product Catalog Version

Introduction

This operation retrieves the version for a specified product catalog identifier.

Method

Service Name

Service Type

GET

productCatalog/{productCatalogId}/version

Synchronous

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

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

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}/version

The following parameters are available:

Parameter

Description

Type

Required

catalogId

The internal identifier of the product catalog

String

Y

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

Response Elements

The following elements are returned in the response.

Name

Description

Type

version

Version of the catalog

Integer

Sample Request and Response

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

GET /productCatalogManagement/v1/productCatalog/TWD0B2FLAGQ9KV6S9AY8NFJJJR/version HTTP/1.1
requestorId: CLMMVC5PQRRYHGZCG6LX47Z6T8
Content-Type: application/json; charset=UTF-8
Accept: application/json; charset=UTF-8
Host: api.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.2 (java 1.5)
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 15 Oct 2012 18:42:11 GMT
Content-Length: 16
Server: Jetty(8.1.2.v20120308)

Did this page help you?