Query Product Lines by Criteria

Introduction

This API returns a list of elements from the product line summary that includes a subset of the product lines that meet the specified criteria and cursor view parameters.

Method

Service Name

Service Type

GET

productManagement/v1/productLines

Synchronous

URI: https://api.blackhawknetwork.com/productManagement/v1/productLines?{first}={firstIndex}&{maximum}={maximumNumofEntries}&{sortKey}=(summary|details).{attributeName}&{ascending}={true|false}&{exactMatch}={true|false}&{caseSensitive}={true|false}&{lt|le|gt|ge|eq|ne}({summary|details}.{attributeName},{attributeValue})

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 URI itself. https://api.blackhawknetwork.com/productManagement/v1/productLines?{first}={firstIndex}&{maximum}={maximumNumofEntries}&{sortKey}=(summary|details).{attributeName}&{ascending}={true|false}&{exactMatch}={true|false}&{caseSensitive}={true|false}&{lt|le|gt|ge|eq|ne}({summary|details}.{attributeName},{attributeValue})

The following parameters are available:

Parameter

Description

Type

Required

first

The index of the first entity in this cursor view of the list.

The default first index is zero referring to the first entity in the full list.

Integer
String

N

maximum

The maximum number of entities to be shown in this cursor view of the list. The default value is 10.

Integer
String

N

sortKey

The name of the attribute that should be used for ordering the results. If this value is not provided, then there is no explicit sorting of the results.

Only attributes in product line summary can be used for for ordering the results.

String

N

ascending

Whether or not the results are sorted in ascending order. The default value is true.

Boolean
String

N

exactMatch

Flag to exactly match the provided supported features.

Boolean

N

caseSensitive

Flag to exactly match the case of the supported features.

Boolean

N

Response Elements

The following elements are returned in the response.

Name

Description

Type

productLineSummaryList

List of matching product line summary entities.

List

total

Total count returned from the query.

Integer

parameters

The Request Elements specified in the request or their default values if none specified.

List

Product Line Summary

Name

Description

Type

Max Length

Mandatory

entityId

A reference to the URI for the product line.

URI

255

N

brandName

The name of the brand.

String

255

Y

brandLogoImage

The URI of the logo image of the brand.

String

255

N

productLineName

Name of the product line.

String

Y

brandId

ID of the brand.

String

26

N

productLineStatus

The status of the product line. The possible values are in the Product Line Status enumeration.

Enum

N

accountType

The account type of the product line. The possible values are in the Account Type enumeration.

Enum

N

paymentNetworkType

The payment network type of the product line. The possible values are in the Payment Network Type enumeration.

Enum

N

startDate

The date from which the product line becomes active.

Date

Y

endDate

The date at which the product line becomes inactive.

Date

N

locale

The two-character ISO 639-1 language code followed by the two-character country code, separated by an underscore, e.g., en_US.

Locale

5

N

Product Line Status

Enum Value

Description

DRAFT

New product line in draft mode.

ACTIVATED

Product line in active mode.

SUSPENDED

Product line in suspended mode.

Account Type

Enum Value

Description

CREDIT_CARD

Credit card

GIFT_CARD

Gift card

LOYALTY_CARD

Loyalty card

PHONE_CARD

Phone card

Payment Network Type

Enum Value

Description

VISA

Visa

MASTERCARD

Master Card

DISCOVER

Discover

AMEX

American Express

Sample Request and Response

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

GET /productManagement/v1/productLines?first=0&maximum=10&sortKey=summary.brandName&ascending=true&exactMatch=false&caseSensitive=false&eq(summary.productLineStatus,ACTIVATED)&ge(details.createdTimestamp,2013-06-01T21:12:00.000%2B0000)&le(details.createdTimestamp,2020-06-02T21:12:00.000%2B0000) HTTP/1.1
requestorID: ZPZB7DDS20PNHALMZCBX14RVCM
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
Server: Apache-Coyote/1.1
Cache-Control: max-age=3600
Date: Tue, 09 Jul 2013 18:41:44 GMT
Content-Type: application/json
Content-Length: 5673

{
   "results":[
      {
            "entityId":"https://api.blackhawknetwork.com/productManagement/v1/productLine/LRWMS0GDZSJ6PAD180DC937T2M",
            "productLineName":"Retailer_A",
            "brandName":"Retailer_A",
            "brandCode":"",
            "brandLogoImage":"https://content.giftcardmall.com/gcmimages//MANUFACTURER/icon/GOWALLET_METADATA/380V4646.0.PNG",
            "productLineStatus":"ACTIVATED",
            "accountType":"GIFT_CARD",
            "startDate":"2012-09-17T22:54:14.987+0000",
            "endDate":"2023-02-19T22:59:41.280+0000",
            "locale":"en_US"
      },
      {
            "entityId":"https://api.blackhawknetwork.com/productManagement/v1/productLine/NJ8ZXBVPDAKG5H378JFG8QLLY8",
            "productLineName":"Retailer_B",
            "brandName":"Retailer_B",
            "productLineStatus":"ACTIVATED",
            "accountType":"GIFT_CARD",
            "startDate":"2008-09-17T20:16:53.793+0000",
            "endDate":"2023-03-12T01:59:00.000+0000",
            "locale":"en_US"
      }
   ],
   "total":2,
   "parameters":{
      "first":0,
      "maximum":10,
      "sortKey":"summary.brandName",
      "ascending":true
   }
}

Did this page help you?

Developer Central Agreement

  1. License from Blackhawk. Subject to your full compliance with all of the terms and conditions of this Agreement and the Terms of Use, Blackhawk grants you a non-exclusive, revocable, non-sublicensable, nontransferable license to use and integrate the Blackhawk Developer Tools into your Application solely to test them in Blackhawk’s sandbox environment.
  2. Passwords, Credentials and Access. Blackhawk will provide (or you will be requested to establish) a password or other procedures for verifying that only designated personnel have access to Blackhawk Developer Tools. Blackhawk may provide you with unique confidential identification codes, credentials and certificates that enable you to use the Blackhawk Developer Tools. You may not share any such items with any third party without the prior written consent of Blackhawk, and you agree to notify Blackhawk immediately of any violation of your foregoing obligations. You are responsible for maintaining the security of your account, passwords, credentials, codes, certificates and other files, and for all uses of your account, and you are liable for all activities performed under your account or otherwise with your credentials, codes and certificates.
  3. Restrictions and Obligations. You may not use the Blackhawk Developer Tools for any purpose other than as expressly set forth herein without Blackhawk’s prior written consent, including without limitation to access Blackhawk user data or information without authorization or in any manner or for any purpose that violates any law or regulation or any right of any person (including but not limited to intellectual property rights or rights of privacy). You may not use the Blackhawk Developer Tools to build a product or service that is competitive with the Blackhawk Services, or engage in any practices that discriminate against or discourage the use of Blackhawk Services. In addition, you shall not use the Blackhawk Developer Tools or Blackhawk Services in connection with or to promote any Applications or other products, services, or materials that constitute, promote or are used for the purpose of dealing in: spyware, adware, or other malicious programs or code; counterfeit goods; items subject to U.S. embargo; unsolicited mass distribution of email; multi-level marketing proposals; hate materials; hacking/surveillance/interception/descrambling equipment; libelous, defamatory, obscene, pornographic, abusive or otherwise offensive content; prostitution; gambling; stolen products or items used for theft; fireworks, explosives, or hazardous materials; or weapons. Without limiting the foregoing, you shall not use the Blackhawk Developer Tools or Blackhawk Services for any illegal purpose. Except as expressly and unambiguously authorized under this Agreement, you may not (i) copy, rent, lease, sell, transfer, assign, sublicense, disassemble, reverse engineer or decompile (except to the limited extent such restrictions are expressly prohibited by applicable statutory law), modify or alter any part of the Blackhawk Developer Tools or Blackhawk Services, or (ii) otherwise use the Blackhawk Developer Tools or Blackhawk Services on behalf of any third party.   You may not use any robot, spider, or other automatic device to create accounts for use of the Blackhawk Developer Tools and you will not take any action that imposes an unreasonable or disproportionately large load on Blackhawk’s infrastructure.
  4. Support; Other Conditions of Use. Blackhawk may provide you with support or modifications for the Blackhawk Developer Tools (collectively, “Support”) in its sole discretion. Blackhawk may terminate such Support at any time without notice to you. Blackhawk may change, suspend, or discontinue any aspect of the Blackhawk Developer Tools, at any time, including the availability of any APIs. Blackhawk may release subsequent versions of APIs, and you may be required to use those subsequent versions. Blackhawk may also impose limits on certain features and services or restrict your access to parts of or all of the Blackhawk Developer Tools without notice or liability. Your networks, operating systems, software, web server(s), routers, databases and other computer systems must be properly configured to Internet industry standards, as required to securely operate your Application.
  5. Sandbox Environment; Data. You may use the sandbox environment provided as part of the Blackhawk Developer Tools (“Sandbox”) in order to test the Blackhawk Services. If you access the Sandbox with a digital certificate provided by Blackhawk, your use of the Sandbox and any data or information you input into the Sandbox will be available only to users that access the Developer Portal with your account. Important: If you access the Sandbox without a digital certificate provided by Blackhawk, your use of the Sandbox, and any data or information that you input into the Sandbox, will be available to all users that access the Developer Portal. You may only use anonymous, non-live data and you may not enter any confidential, sensitive or personally identifiable information into the Sandbox. Data and other information provided to or made available in the Sandbox is not encrypted. Blackhawk will have no responsibility or liability for any information you enter into the Sandbox, or otherwise from your use of the Sandbox. You are fully responsible for the security of any data or information you provide in connection with the Developer Portal, and you must comply with all applicable laws and rules in connection with your provision and use of such data and information.
  6. Proprietary Rights. As between you and Blackhawk, the Blackhawk Developer Tools, Blackhawk Services and all intellectual property rights therein are and shall at all times remain the sole and exclusive property of Blackhawk and are protected by applicable intellectual property laws and treaties. As between you and Blackhawk, your Application and all intellectual property rights therein (but excluding any Blackhawk intellectual property therein) are and shall at all times remain your sole and exclusive property. You acknowledge and agree that any questions, comments, suggestions, ideas, feedback or other information about the Blackhawk Developer Tools or Blackhawk Services (“Submissions”), provided by you to Blackhawk are voluntary, non-confidential and Blackhawk will be entitled to the unrestricted use and dissemination of these Submissions for any purpose, commercial or otherwise, without acknowledgment or compensation to you.
  7. Trademarks. This Agreement does not include any right for you to use any trademark, service mark, trade name or any other mark of Blackhawk or any other party or licensor. You agree that Blackhawk may list your name and/or your Application (including by displaying any trademarks related thereto) and identify the business relationship between the parties on Blackhawk’s websites, the Blackhawk Services and in other marketing and advertising collateral. No rights or licenses are granted except as expressly and unambiguously set forth herein.
  8. Confidentiality. “Confidential Information” means all information related to the Developer Portal, including but not limited to the following: (i) any information you receive or enter via the Blackhawk Developer Tools (including the sandbox environment), (ii) the Blackhawk Developer Tools and all related information and materials, including without limitation API credentials and all access IDs and passwords, (iii) all information disclosed in writing and marked “confidential”, proprietary,” or with a substantially similar marking, (iv) all information disclosed orally and identified as confidential at the time of the disclosure, and (v) any other information that by its nature you understand or would reasonably be expected to understand to be Blackhawk’s confidential information. You must maintain Blackhawk’s Confidential Information in confidence and must not disclose it to third parties or use it for any purpose other than as necessary and required to develop your Application as permitted herein. In the event that Confidential Information is required to be disclosed by a court, government agency, regulatory requirement, or similar disclosure requirement, you shall immediately notify Blackhawk and use reasonable efforts to obtain confidential treatment or a protection order of any disclosed Confidential Information. Your obligations hereunder shall survive the termination of this Agreement. You acknowledge that monetary damages may not be a sufficient remedy for unauthorized use or disclosure of Confidential Information and that Blackhawk will be entitled (without waiving any other rights or remedies) to injunctive or equitable relief as may be deemed proper by a court of competent jurisdiction, without obligation to post any bond.
  9. Warranty Disclaimer. THE BLACKHAWK DEVELOPER TOOLS AND BLACKHAWK SERVICES ARE PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND. BLACKHAWK AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, REGARDING THE BLACKHAWK DEVELOPER TOOLS AND BLACKHAWK SERVICES, INCLUDING WITHOUT LIMITATION ANY AND ALL IMPLIED WARRANTIES OF MERCHANTABILITY, ACCURACY, RESULTS OF USE, RELIABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, INTERFERENCE WITH QUIET ENJOYMENT, AND NON-INFRINGEMENT OF THIRD PARTY RIGHTS. FURTHER, BLACKHAWK DISCLAIMS ANY WARRANTY THAT YOUR USE OF THE BLACKHAWK DEVELOPER TOOLS OR BLACKHAWK SERVICES WILL BE UNINTERRUPTED OR ERROR FREE.
  10. Limitation of Liability. REGARDLESS OF WHETHER ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE OR OTHERWISE, AND EXCEPT FOR BODILY INJURY, IN NO EVENT WILL BLACKHAWK OR ITS SUPPLIERS BE LIABLE TO YOU OR TO ANY THIRD PARTY UNDER ANY TORT, CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHER LEGAL OR EQUITABLE THEORY FOR (A) ANY LOST PROFITS, LOST OR CORRUPTED DATA, COMPUTER FAILURE OR MALFUNCTION, INTERRUPTION OF BUSINESS, OR OTHER SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING OUT OF THE USE OR INABILITY TO USE THE BLACKHAWK DEVELOPER TOOLS OR BLACKHAWK SERVICES, EVEN IF BLACKHAWK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGES AND WHETHER OR NOT SUCH LOSS OR DAMAGES ARE FORESEEABLE, OR (B) ANY DAMAGES RELATING TO THE BLACKHAWK DEVELOPER TOOLS OR YOUR USE THEREOF. 
  11. Indemnification. You agree that Blackhawk shall have no liability whatsoever for any use you make of the Blackhawk Developer Tools or Blackhawk Services. You shall indemnify and hold harmless Blackhawk from any and all claims, damages, liabilities, costs and fees (including reasonable attorneys’ fees) arising from your Applications or otherwise from your use of the Blackhawk Developer Tools or Blackhawk Services, or your breach of this Agreement.
  12. Term and Termination. This Agreement shall continue until terminated as set forth in this Section. Either party may terminate this Agreement upon written notice to the other party at any time, for any reason, or for no reason including, but not limited to, if you violate any provision of this Agreement. Any termination of this Agreement shall also terminate the license(s) granted hereunder. Upon termination of this Agreement for any reason, you shall destroy and remove from all computers, hard drives, networks and other storage media all copies of the Blackhawk Developer Tools, and shall so certify to Blackhawk upon request that such actions have occurred. Sections 2, 3 and 6 through 13 and all accrued rights to payment (if any) shall survive termination of this Agreement.
  13. Government Use. If you are part of an agency, department, or other entity of the United States Government (“Government”), the use, duplication, reproduction, release, modification, disclosure or transfer of the Blackhawk Developer Tools are restricted in accordance with the Federal Acquisition Regulations as applied to civilian agencies and the Defense Federal Acquisition Regulation Supplement as applied to military agencies. The Blackhawk Developer Tools is a “commercial item,” “commercial computer software” and “commercial computer software documentation.” In accordance with such provisions, any use of the Blackhawk Developer Tools by the Government shall be governed solely by the terms of this Agreement.
  14. Export Controls. You shall comply with all export laws and restrictions and regulations of the Department of Commerce, the United States Department of Treasury Office of Foreign Assets Control (“OFAC”), or other United States or foreign agency or authority, and you shall not export, or allow the export or re-export of the Blackhawk Developer Tools or Blackhawk Services in violation of any such restrictions, laws or regulations. By accessing or using the Blackhawk Developer Tools, you agree to the foregoing and represent and warrant that you (and the organization you represent, if any) are not located in, under the control of, or a national or resident of any restricted country.
  15. Miscellaneous. Unless the parties have entered into a written amendment to this agreement that is signed by both parties regarding the Blackhawk Developer Tools or the Blackhawk Services, this Agreement constitutes the entire agreement between you and Blackhawk pertaining to the subject matter hereof, and supersedes any and all written or oral agreements with respect to such subject matter. This Agreement, and any disputes arising from or relating to the interpretation thereof, shall be governed by and construed under California law without reference to its conflict of laws principles or the United Nations Conventions on Contracts for the International Sale of Goods. Except to the extent otherwise elected by Blackhawk, any action or proceeding arising from or relating to this Agreement must be brought in a federal court in the Northern District of California or in state court in San Francisco County, California, and each party irrevocably submits to the jurisdiction and venue of any such court in any such action or proceeding. The prevailing party in any action arising out of this Agreement shall be entitled to an award of its costs and attorneys’ fees. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only to the extent necessary to make it enforceable. The failure of Blackhawk to act with respect to a breach of this Agreement by you or others does not constitute a waiver and shall not limit Blackhawk’s rights with respect to such breach or any subsequent breaches. This Agreement is personal to you and may not be assigned or transferred for any reason whatsoever without Blackhawk’s prior written consent and any action or conduct in violation of the foregoing shall be void and without effect. Blackhawk may freely transfer or assign this Agreement and delegate any of its obligations hereunder.

I Agree