Read Product
Introduction
This API retrieves product information for the specified product ID.
| Method | Service Name | Service Type |
|---|---|---|
| GET | productManagement/v1/product | Synchronous |
- Post-Production URI: `https://api.certification.blackhawknetwork.com/productManagement/v1/products?productID={productId}'
- Production URI: `https://api.blackhawknetwork.com/productManagement/v1/products?productID={productId}'
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/products?configurationId={configurationId}
The following parameters are available:
| Parameter | Description | Type | Required |
|---|---|---|---|
| productId | The internal identifier for the product | String | Y |
Response Elements
The following elements are returned in the response.
Product
Product Summary
| Name | Description | Type | Max Length | Mandatory |
|---|---|---|---|---|
| entityId | A reference to the URI for the product. | URI | N | |
| productName | The name of the product | String | 255 | Y |
| currency | The currency of the product | Currency | N | |
| universalProductCode | The UPC of the product | String | 50 | Y |
| productLineId | The product line id of the product | Integer | Y | |
| startDate | The date from which the product becomes active | Date | Y | |
| endDate | The date at which the product becomes inactive | Date | N | |
| locale | The two characters ISO 639-1 language code and 2 characters for the country code (separated by an underscore). eg: en_US | Locale | 5 | N |
Product Details
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| creatorId | A reference to the URI for the person who created this product | URI | N | |
| updaterId | A reference to the URI for the person who last updated this product | URI | N | |
| notes | Any notes associated with the last update of the product | String | 255 | N |
| createdTimestamp | Date and time (UTC) at which the entity got created | Date | N | |
| updatedTimestamp | Date and time (UTC) at which the entity was last updated | Date | N | |
| productDescription | The description of product | String | 65,000 | N |
| defaultProductConfigurationId | The default product configuration id | Guid | N | |
| isTaxable | Flag determining whether the product is taxable | Boolean | N | |
| searchKeywords | The set of search keywords of the product | Set | N | |
| activationCharacteristics | The Activation Characteristics of the product | Activation Characteristics | N | |
| reloadCharacteristics | The Reload Characteristics of the product | Reload Characteristics | N | |
| fulfillmentCharacteristics | The set of Fulfillment Characteristics of the product | Set | N | |
| productFees | The list of Product Fee entities of the product | List | N | |
| redemptionCharacteristics | The Redemption Characteristics of the product | Redemption Characteristics | N | |
| termsAndConditions | The set of Terms And Conditions of the product | Set | N | |
| productConfigurations | The set of Product Configuration entities of the product | Set | N |
Activation Characteristics
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| baseValueAmount | Base value amount of the product | BigDecimal | N | |
| maxValueAmount | Maximum value amount of the product | BigDecimal | N | |
| isVariableValue | Indicates if the amount of the product is variable or fixed | boolean | N | |
| activationInstructions | Activation instructions of the product | String | 2048 | N |
Reload Characteristics
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| minReloadAmount | The minimum amount that has to be re-loaded on a card. | BigDecimal | N | |
| maxReloadAmount | The maximum amount that can be re-loaded on a card. | BigDecimal | N | |
| isReloadable | Is the card reloadable. | Boolean | N |
Fulfillment Characteristics
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| id | The primary key for the entity.This is used only for internal purposes. | String | 26 | N |
| fulfillmentInformation | Fulfillment information. | String | 1024 | N |
| holdTimeSeconds | Hold time in seconds. | BigDecimal | N | |
| printingType | Printing type | Printing type | N | |
| provisioningType | Provisioning type | Provisioning type | N | |
| fulfillmentMethod | Fulfillment Method | Fulfillment Method | N |
Printing Type
| Enum Value | Description |
|---|---|
| PRINT_ON_DEMAND | Print on demand |
| PRE_PRINTED | Pre printed for physical card |
| SEMI_PRE_PRINTED | Semi pre printed for physical card |
| CUSTOM_PRINT_ON_DEMAND | Custom print on demand for physical card |
Provisioning Type
| Enum Value | Description |
|---|---|
| PHYSICAL | Provisioning type for physical card |
| DIGITAL | Provisioning type for digital card |
Fulfillment Method
| Enum Value | Description |
|---|---|
| SHIPMENT | Shipment for physical card |
| Email for virtual card | |
| URL | URL for virtual card |
| IMAGEDATA | ImageData for virtual card |
| SMS | SMS for virtual card |
Product Fees
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| chargeAmount | The charge amount | BigDecimal | N | |
| feeType | This enumeration captures the possible fee types | Fee Type | N | |
| id | The primary key of the entity.This is used only for internal purposes | String | 26 | N |
Fee Type
| Enum Value | Description |
|---|---|
| CUSTOMIZATION | Customization |
| PURCHASE | Purchase |
| INACTIVITY | Inactivity |
| TRANSACTION | Transaction |
| REPLACEMENT | Replacement |
Redemption Characteristics
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| redemptionWebsite | The website where a card can be redeemed | String | 255 | N |
| additionalDataLabel | The text of the additional data on the card needed for redemption | String | 255 | N |
| redemptionMode | This enumerated type captures the possible types of redemption on a card | Redemption Mode | N | |
| manualEntryFormat | The format of the redemption data if entered manually | String | 255 | N |
| barCodeCharacteristics | The format of the redemption data if entered manually | Set | N | |
| magneticStripeCharacteristics | The magnetic stripe characteristics of the product | Magnetic Stripe Characteristics | N | |
| redemptionText | The Redemption Text for the product. | Redemption Text | N | |
| redemptionTexts | Set of Redemption Text entities for the product. This is the preferred method of associating redemption text entities to products. The redemptionText field has been retained for backwards compatibility. | Set< Redemption Text> | N | |
| redemptionOptions | The possible redemption options available for the product | Set | N | |
| productExpirationDate | Static expiration date for the card | Date | N | |
| rollingExpirationDays | Number of days for the expiration of the product staring from the date of activation. | Integer | N |
Redemption Mode
| Enum Value | Description |
|---|---|
| BAR_CODE | Bar Code |
| MAGNETIC_STRIPE | Magnetic Stripe |
| NEAR_FIELD | Near Field |
| MANUAL_ENTRY | User Entered |
Barcode Characteristics
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| id | The primary key for the entity.This is used only for internal purposes | String | 26 | N |
| barCodeFormat | The format of the bar code. | String | 255 | N |
| barCodeType | This enumerated type captures the possible types of barcode types. | Barcode Type | N | |
| barCodeSubType | This enumerated type captures the possible types of barcode subtypes. | Barcode Subtype | N |
Barcode Type
| Enum Value | Description |
|---|---|
| ONE_DIMENSIONAL | One Dimensional |
| TWO_DIMENSIONAL | Two Dimensional |
Barcode Subtype
| Enum Value | Description |
|---|---|
| CA128 | Bar Code is of type CA128 |
| PDF417 | Bar Code is of type PDF417 |
Magnetic Stripe Characteristics
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| redemptionTracks | The track number(s) on the magnetic stripe which should be used for redemption. | Set | N | |
| track1Format | The format of Track 1 on the magnetic stripe. | String | 255 | N |
| track2Format | The format of Track 2 on the magnetic stripe. | String | 255 | N |
| track3Format | The format of Track 3 on the magnetic stripe. | String | 255 | N |
Redemption Text
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| id | The primary key for the entity.This is used only for internal purposes | String | 26 | N |
| text | The redemption text instructs how to redeem a card | String | 8192 | N |
| redemptionTextType | The possible redemption text types available for the product | Redemption Text Type | N |
Redemption Text Type
| Enum Value | Description |
|---|---|
| REDEMPTION_INFORMATION | Redemption Information |
| IN_STORE_INSTRUCTIONS | In store instructions |
| ON_LINE_INSTRUCTIONS | On line instructions |
| REDEMPTION_LINE_1 | Redemption line 1 |
| REDEMPTION_LINE_2 | Redemption line 2 |
Redemption Options
| Enum Value | Description |
|---|---|
| ON_LINE | Redemption available through online |
| IN_STORE | Redemption available only in store |
Terms and Conditions
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| id | The primary key for this entity.This is used only for internal purposes | String | N | |
| termsAndConditions | The terms and conditions of the product | String | N | |
| termsAndConditionsType | The possible values that the terms and conditions can have. | Terms And Conditions Type | Y |
Terms and Conditions Type
| Enum Value | Description |
|---|---|
| WEB | Web |
| PHYSICAL | Physical |
Product Configurations
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| configurationId | The internal identifier of the product configuration. | String | ||
| configurationName | The name of the configuration | String | ||
| configurationDescription | The description of the configuration | String | ||
| itemId | The item id of the product | Integer | ||
| startDate | Date and time (UTC) at which the configuration becomes active | Date | ||
| endDate | Date and time (UTC) at which the configuration becomes expired | Date | ||
| configurationStatus | Configuration Status | Configuration Status | ||
| productImages | Set of Product Image entities | Set |
Configuration Status
| Enum Value | Description |
|---|---|
| DRAFT | New Product in draft mode |
| ACTIVATED | Product in active mode |
| SUSPENDED | Product in suspended mode |
Product Images
| Name | Description | Type | Max. Length | Mandatory |
|---|---|---|---|---|
| frontImage | The image on the front of the card. | String | 255 | N |
| backImage | The image on the back of the card. | String | 255 | N |
| imageSize | This enumeration captures the possible sizes of the image | Image Size | N | |
| imageType | This enumeration captures the possible types of the image | Image Type | N | |
| id | The primary key of the entity | String | 26 | N |
Image Size
| Enum Value | Description |
|---|---|
| SMALL | Small Image (119x76) |
| MEDIUM | Medium Image (144x92) |
| LARGE | Large Image (240x153) |
| EXTRA_LARGE | Extra Large Image (308x198) |
Image Type
| Enum Value | Description |
|---|---|
| LEGAL_DISCLAIMER | Legal disclaimer image |
| TERMS_CONDITIONS | Terms and conditions image |
| PRINT_ON_DEMAND_IMAGE | Print on demand image |
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 response.
GET https://apipp.blackhawknetwork.com/productManagement/v1/product/CYLC5NLZ4XH47VSJYN9W6GT2A4 HTTP/1.1
Accept-Encoding: gzip,deflate
tenantId: JB3JRH34DRWW0QD91VZNL9WM04
requestorId: JB3JRH34DRWW0QD91VZNL9WM04
certificateId: JB3JRH34DRWW0QD91VZNL9WM04
Host: apipp.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
{
"entityId": "https://apipp.blackhawknetwork.com/productManagement/v1/product/CYLC5NLZ4XH47VSJYN9W6GT2A4",
"summary": {
"entityId": "https://apipp.blackhawknetwork.com/productManagement/v1/product/CYLC5NLZ4XH47VSJYN9W6GT2A4",
"productName": "Chili's eGift",
"currency": "USD",
"universalProductCode": "07675008491",
"productLineId": "https://apipp.blackhawknetwork.com/productManagement/v1/productLine/AH2XLVX88598BBPKCNSVZ3AGVC",
"startDate": "2010-09-15T07:00:00.000+0000",
"locale": "en_US"
},
"details": {
"creatorId": "HPCDKMSV763K2VGHCKQQ09QSGM",
"updaterId": "FWVJKCH8TM6V284GM2RC8QR3FC",
"createdTimestamp": "2013-03-03T15:56:37.403+0000",
"updatedTimestamp": "2014-05-03T07:00:41.326+0000",
"additionalAttributes": [],
"productDescription": "Head to Chili’s Grill & Bar for our sizzlin’ service and a taste of our Southwestern favorites like our Grilled Baby Back Ribs, Big Mouth Burgers® or our marinated fajitas.",
"isTaxable": false,
"searchKeywords": [],
"activationCharacteristics": {
"baseValueAmount": 20,
"maxValueAmount": 100,
"isVariableValue": true,
"activationInstructions": ""
},
"reloadCharacteristics": {"isReloadable": false},
"fulfillmentCharacteristics": [ {
"id": "VQW47HH95XXKD7N4PSXF1713YW",
"holdTimeSeconds": 720,
"provisioningType": "DIGITAL",
"fulfillmentMethod": "EMAIL"
}],
"productFees": [
{
"id": "LDSWBL73Q8FH2YW0J98MAWANF0",
"chargeAmount": 0,
"feeType": "CUSTOMIZATION"
},
{
"id": "1AR3X3T0ZTVNQQLRAAD1QRV194",
"chargeAmount": 0,
"feeType": "PURCHASE"
}
],
"redemptionCharacteristics": {
"redemptionTexts": [
{
"id": "LX6148ZB2YLBKXZDWSYAJ8XQDR",
"text": "To redeem this virtual gift card please process the gift card manually by keying in the gift card number. If any balance remains on the virtual card, please return this card to the Guest along with a copy of their gift card receipt.",
"redemptionTextType": "SALES_ASSOCIATE_INSTRUCTIONS"
},
{
"id": "C93L0V6LHYDKX4HK30ZQSKWNT4",
"text": "Instore",
"redemptionTextType": "REDEMPTION_INFORMATION"
},
{
"id": "KPLG6N6AFKA2HXJVDMAKJPPXH4",
"text": "Please print this virtual gift card and take it to any Chili's Grill & Bar, Romano's Macaroni Grill, On The Border or Maggiano's Little Italy for redemption. Valid in the US, Puerto Rico and our international restaurants located on US Military Bases.",
"redemptionTextType": "IN_STORE_INSTRUCTIONS"
}
],
"redemptionOptions": ["IN_STORE"],
"barCodeCharacteristics": [],
"magneticStripeCharacteristics": {"redemptionTracks": []}
},
"termsAndConditions": [
{
"id": "BFBLLWX6X3RFR30FQ6QY8L0N1M",
"termsAndConditions": "For balance inquiry or customer service, call 1-888-532-6092. You may redeem this card for food or beverages at any Chili's Grill & Bar, Romano's Macaroni Grill, On The Border Mexican Grill & Cantina or Maggiano's Little Italy restaurant in the U.S. Card may not be redeemed for cash, except as required by law. Original activation receipt is required for replacement of lost or stolen gift cards. No service fees are charged in connection with this card. Issued by Brinker Services Corporation. For location information, visit www.chilis.com.",
"termsAndConditionsType": "PHYSICAL"
},
{
"id": "2CAWWCLS1QVJVNMWW8FFFZ3M14",
"termsAndConditions": "For balance inquiry or customer service, call 1-888-532-6092. You may redeem this card for food or beverages at any Chili’s Grill & Bar, Romano’s Macaroni Grill, On The Border Mexican Grill & Cantina or Maggiano’s Little Italy restaurant in the U.S. Card may not be redeemed for cash, except as required by law. Original activation receipt is required for replacement of lost or stolen gift cards. No service fees are charged in connection with this card. Issued by Brinker Services Corporation. For location information, visit www.chilis.com.",
"termsAndConditionsType": "WEB"
}
],
"productConfigurations": [ {
"configurationId": "ZYJ6FSTR7RM5CXT39X6K6TH7XR",
"configurationName": "Chili's eGift",
"itemId": 35213,
"startDate": "2010-09-15T07:00:00.000+0000",
"configurationStatus": "ACTIVATED",
"productImages": [
{
"id": "K4C8AB77R5NQPHYD18377K8ZLW",
"frontImage": "https://gcmpreprod.blackhawk-net.com/gcmimages/product/large/1564.jpg",
"imageSize": "LARGE"
},
{
"id": "QD9PZTRK7G1TBKJ8S7626RMVDH",
"frontImage": "https://gcmpreprod.blackhawk-net.com/gcmimages/product/xlarge/1564.jpg",
"imageSize": "EXTRA_LARGE"
}
]
}]
}
}
Updated 4 months ago