Filter Products by Catalog

Introduction

This service can be used to filter the list of products returned in a product catalog. This is useful if you want to return product information about a single product or for a subset of the products contained in the catalog.

Method

Service Name

Service Type

GET

productCatalog/{productCatalogId}/productIds

Synchronous

URI: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/{productCatalogId}/productIds?filterIds={productId1};{productId2};{productId3}

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.

String

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}/productIds?filterIds={productId1};{productId2};{productId3}

The following parameters are available:

Name

Description

Type

Required

catalogId

The internal identifier of the product catalog

String

Y

productIds

';' (semi colon) separated list of one or more productIds

String

Y

For example: https://api.blackhawknetwork.com/productCatalogManagement/v1/productCatalog/BM3TNCWAKXD6ADBS7RNPLK7MNH/productIds?filterIds=82FYC2GN5SCZ3GBBKPDQZTVBR4;AMK2MKSA9X3RL9WHM18L0KFDJR;3AMMRQR0BJ4T8AZ7QNL1HBPT6H;CQJ86DQYML92XMJFJJMW0W9T0R;NVR6HB9APW6626LXDB0H8002Y8

Response Elements

The following elements are returned in the response.

Name

Description

Type

productids

Filtered list of productIds for the given catalogId

List

Sample Request and Response

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

GET /productCatalogManagement/v1/productCatalog/BM3TNCWAKXD6ADBS7RNPLK7MNH/productIds?filterIds=82FYC2GN5SCZ3GBBKPDQZTVBR4;AMK2MKSA9X3RL9WHM18L0KFDJR;3AMMRQR0BJ4T8AZ7QNL1HBPT6H;CQJ86DQYML92XMJFJJMW0W9T0R;NVR6HB9APW6626LXDB0H8002Y8 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: 3VHDZA1L2GVJK2J2GYRGSAM860
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 08 Oct 2012 16:23:51 GMT
Content-Length: 59
["http://api.blackhawknetwork.com/productManagement/v1/product/CQJ86DQYML92XMJFJJMW0W9T0R",http://api.blackhawknetwork.com/productManagement#v1/product/NVR6HB9APW6626LXDB0H8002Y8]

Did this page help you?