Get Campaign Info
Introduction
This operation retrieves information for a campaign matching the BPID and campaign code provided.
Method | Service | API Name | Service Type |
---|---|---|---|
GET | campaigns | read → Explore | Synchronous |
URI: {baseUrl}/campaigns/v1/read/{bpId}/{campaignCode}
Header Elements
The header must contain the elements needed to authenticate the request.
Parameter | Description | Type | Required |
---|---|---|---|
authorization | This is where you will send your encoded JWT auth token you obtained from Get Auth Token. Must be in the form: Authorization: Bearer {auth-token-string} | String | Yes |
Request Elements
The following resource values must be sent with every request.
Parameter | Description | Type | Required |
---|---|---|---|
bpId | Business Partner ID The unique identifier for the business partner. This value will be provided to you by your Account Manager. | Integer | Yes |
campaignCode | The campaign code for the campaign you wish to retrieve information for. | String | Yes |
Sample Request
Example: https://certification.promob2b.bhnapi.com/campaigns/v1/read/98765/32-12345
GET https://{baseUrl}/campaigns/v1/read/98765/32-12345 HTTP/1.1
host: {baseUrl}
accept: application/json'
content-type: application/json'
cache-control: no-cache
authorization: Bearer eyJraWQiOiJOZm9uOFI3T0xkTmNPUlNSUVhzdW13WXlOZzRtblB1LTA3ZzhKTEw2NGZvIiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULnQ4NnVfaTJHeG01T1p0TmlOSHNjTnJDaGZTNUgtcVhLelJYZTBoMkMtYjQiLCJpc3MiOiJodHRwczovL2Rldi05OTMxMDcub2t0YXByZXZpZXcuY29tL29hdXRoMi9hdXNqanZwZzNhYTl5c05XeTBoNyIsImF1ZCI6Imh0dHBzOi8vd3d3LmJobmV0d29yay5jb20vYXBpIiwiaWF0IjoxNTg0NTYyMjM5LCJleHAiOjE1ODQ1NjU4MzksImNpZCI6IjBvYWprcXdoNnRTR1JXVWN3MGg3Iiwic2NwIjpbIiovKiJdLCJzdWIiOiIwb2Fqa3F3aDZ0U0dSV1VjdzBoNyJ9.PfT7O9Kae-8UEIqjZI5CDV4DdiP2z60I_LTYHIcYMLGYMW6jzvaZLQL9LJvhXpi9uzY5cFhAROOJGK7Uwf616DzTRKJ1_SmcNbxCxuzOknR0tvh6aeLepeVhDW6gdJGic9dW3YYWX2fUdyACCZjjQ3ME_26Oy3qaJj5j89jlJgxTE-QZHDUeCnE5oxRzQQaEF6bXXZ_X_yWEM4bS4PJcp99ysmJO838U0afC9pczatx_LEy2PnET2pP6RNLYx-oq0_LgrdjlV-7C92LQylqzxas-yZbtN7jHD4JvUt6TJchOnce2wQKoId4-rF_Z8NdTzMYfqcgg_L_v2ZbT8xzMRA
Response Elements
The following elements are returned in the response. These describe the campaign and provide you the information needed to create a submission within the campaign.
Demographic Fields
Standard demographic fields are not returned by the CampaignService but are required to create a submission. A list of these fields is available on the Demographic Fields page.
Name | Description | Type | Required |
---|---|---|---|
timestamp | Timestamp when the request completed processing. | Integer | Yes |
status | Status of the response. This will match the HTTP Status Code in the header of the response. Example: 404 | Integer | Yes |
error | If the request was not processed successfully this will indicate the error condition encountered. Example: "Not Found" | String | No |
message | The detailed error message. This will be null if the request completed successfully.Example: "Campaign Code 32-99999 could not be found" | String | No |
path | The path called in the request, excluding the baseUrl. | String | Yes |
campaignInfo | Contains the details of the campaign matching the campaign code provided. | Object | Yes |
type | Represents the type of response payload. The only value currently supported is FULL . | String | Yes |
Campaign Info
Name | Description | Type | Required |
---|---|---|---|
id | Campaign ID | Integer | Yes |
name | Campaign Name | String | Yes |
startDate | Campaign start date in the form of MM-DD-YYYY. Example: 01-14-2020 | String | Yes |
endDate | Campaign end date in the form of MM-DD-YYYY. Example: 01-12-2020 | String | Yes |
tc | The terms and conditions of the offer. | String | Yes |
code | The campaign code. Example: 20-12345 | String | Yes |
attributes | The attributes setup and configured for the campaign being retrieved | Array of Objects | Yes |
products | Products and the associated attributes setup for the campaign being retrieved. | Array of Objects | Yes |
campaignStatus | The current status of the campaign. Possible values: - ARCHIVE - CANCELED - CLOSED - EXPIRED - HOLD - OPEN - PENDING - VIEWONLY Submissions can only be created when the campaign is in an OPEN status. | String | Yes |
primaryOwnerName | This is the name of the owner of the campaign. | String | Yes |
primarySponsorName | This is the name of the sponsor of the campaign. | String | Yes |
resubmissionDays | Number of days after the campaign has closed that a resubmission can be made. | Integer | Yes |
resubmissionAddress | This is the address resubmissions should be addressed to if the campaign supports resubmission by mail. | String | Yes |
customerServicePhone | The customer service phone number registered to be used for this campaign. | String | Yes |
webProperties | Provides additional attributes useful for display on a website or mobile application. | Object | No |
Campaign Attributes
Campaign attributes are attributes that are collected for all submissions regardless of the product selected.
See attributes below.
Products
The products object contains all the product setup for the campaign and the associated attributes on those products.
Name | Description | Type | Required |
---|---|---|---|
id | Unique Blackhawk Network internal identifier for the product. | integer | Yes |
name | Name of the product configured. | String | Yes |
displayName | Recommended display name to be used for the product. | String | Yes |
webDescription | Recommended description to be used for the product when displaying on a website. | String | No |
attributes | All attributes associated with the product. | String | No |
Attributes
The same attributes definitions are used for both campaign and product attributes.
Name | Description | Type | Required |
---|---|---|---|
name | Attribute name. The maximum size is 75. Attribute names are predefined in campaign setup and can be provided by your Account Manager. | String | Yes |
type | Attribute type. Possible values: - TEXT - INTERNATIONAL TEXT - NUMBER - DATE - TIME - BOOLEAN - FLOAT - CURRENCY - DECIMAL - CHOICE - ENCRYPTED See the Field Mapping Formats Reference for more details. | String | Yes |
value | The maximum size is 1000. See Field Mapping Formats for formats based on attribute type. | String | Yes |
displayName | The display name to be used on the website. This may be different from the attribute name. For example the attribute may be named 'Store Location Choice' but the text 'Store Location' is displayed when asking the user to choose an option. This text should be used over the name parameter for the text displayed to the user in the user interface. | String | No |
masterAttributeId | An internal attribute identifier used by Blackhawk Network. | Integer | Yes |
attributeId | An internal attribute identifier used by Blackhawk Network. | ||
mustBeCapturedFlag | An attribute with a value of true for mustBeCapturedFlag and a displayConsumerFlag value of true is required for capture during the online submission process.If displayConsumerFlag value is not true the attribute must be passed when creating a submission but may contain a null value. | Boolean | Yes |
deDupableFlag | Indicates if the field is used as part of a deduplication rule such as a household limit. | Boolean | Yes |
isUCIDFlag | Indicates if the field is used in a third party validation process. | Boolean | No |
isThirdPartyFlag | A true value indicates this value is to be provided as part of a third party validation process. | Boolean | No |
keyVerifyFlag | A true value indicates a data entry operator will be required to perform key verification on this attribute. This is usually used for serial numbers and other complex or long values where it is critically important to ensure the correct value was data entered. | Boolean | No |
reverseKeyVerifyFlag | A true value indicates a data entry operator will be required to perform reverse key verification on this attribute. This is usually used for serial numbers and other complex or long values where it is critically important to ensure the correct value was data entered. | Boolean | No |
usageFlags | Indicates the intended usage for the attribute. Note that there may be multiple usages for a single attribute. Only attributes with a value of true for displayConsumerFlag are intended to be displayed on Blackhawk Network Promocenter websites to be collected from the applicant. | Object | Yes |
displayOrder | Used to indicate the order the attribute should be displayed on the user interface. | Integer | No |
Usage Flags
Usage flags indicate the intended usage for the attribute. There may be multiple usages for a single attribute.
Attributes with a value of true
for displayCareSiteFlag
are intended to be displayed on Blackhawk Network Promocenter websites so that the values can be collected from the applicant.
Name | Description | Type | Required |
---|---|---|---|
displayConsumerCareFlag | A true value indicates the attribute should be displayed in the internal Blackhawk Network consumer care application. | Boolean | Yes |
displayDataEntryFlag | A true value indicates the attribute should be displayed in the internal Blackhawk Network data entry application. | Boolean | Yes |
displayConsumerFlag | A true value indicates the attribute should be displayed to a user for data collection (through a website or other application). When this API is used externally this indicates if the field should be presented to the consumer for data collection as part of the rebate application. | Boolean | Yes |
displayCareSiteFlag | A true value indicates the attribute should be displayed on the Blackhawk Network client facing care website. Example: QuickCare. | Boolean | Yes |
Web Properties
Additional attributes useful to display on a promotion website or application.
Name | Description | Type | Required |
---|---|---|---|
displayStartDate | Promotion start date to display. | String (Date MM-DD-YYYY). Example: 09-23-2019 | Yes |
displayEndDate | Promotion end date to display. | String (Date MM-DD-YYYY). Example: 11-01-2019 | Yes |
validStartDate | Validation start date. | String (Date MM-DD-YYYY). Example: 09-23-2019 | Yes |
validEndDate | Validation end date. | String (Date MM-DD-YYYY). Example 10-31-2019 | Yes |
webDescription | Description to display. | String | Yes |
promoCenterName | The name of the site in Blackhawk Network's system. | String | No |
Sample Responses
The following samples represent possible responses from this API.
{
"status": 200,
"error": null,
"message": "",
"path": "/campaigns/v1/read/12345/20-12345",
"timestamp": 1585622925906,
"campaignInfo": {
"id": 992113,
"name": "6-PACK OR 12-PACK REBATE",
"startDate": "01/20/2020",
"endDate": "02/08/2020",
"tc": "Save $4.00* on the purchase of one (1) 12-pack of any product. Offer good to residents of CT, DC, DE, FL, GA, MA, MD, ME, NH, NJ, NY, PA, RI, SC, VA and VT only. Purchase Must Occur Between: 01/20/20 - 02/08/20. Request Must Be Submitted By: 03/08/20. Limit one (1) submission per address. Allow 6-8 weeks for receipt of your rebate. Fraudulent submission could result in federal prosecution. Void where prohibited. Employees, affiliated companies, retailers, and distributors are not eligible. Requests from groups, clubs, or organizations will not be honored or returned. Park and Company is not responsible for illegible, lost, late, damaged, incomplete, postage-due or misdirected mail. Your submission acknowledges that the rebate offer will remain outstanding, unaccepted by you, until you have satisfied the following Conditions of Acceptance: (1) submit required items, (2) ensure information provided is accurate and complete, (3) contact 1-555-555-5555 if rebate is not received within 60 days of submission date of request. Your right to receive your rebate will not occur unless you satisfy each of these four Conditions of Acceptance. Your failure to satisfy each of the Conditions of Acceptance is a rejection of this rebate offer.",
"code": "20-12345",
"attributes": [{
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Did this rebate drive your purchase",
"type": "CHOICE",
"value": null,
"displayName": "Did this offer drive your purchase?",
"masterAttributeId": 32397,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": true,
"displayCareSiteFlag": false
},
"attributeId": 2868369,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Gender Choice",
"type": "CHOICE",
"value": null,
"displayName": "Gender",
"masterAttributeId": 14737,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": true,
"displayCareSiteFlag": true
},
"attributeId": 2868352,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Customer Age",
"type": "NUMBER",
"value": null,
"displayName": "Customer Age",
"masterAttributeId": 20457,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868357,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Opt In for Email Contact",
"type": "BOOLEAN",
"value": null,
"displayName": "Opt In for Email Contact",
"masterAttributeId": 4256,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868360,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "System_Config Upload Button 1",
"type": "TEXT",
"value": "Receipt-1-3",
"displayName": "System_Config Upload Button 1",
"masterAttributeId": 26017,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868363,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "System_Config Upload Button 2",
"type": "TEXT",
"value": "UPC-1-5",
"displayName": "System_Config Upload Button 2",
"masterAttributeId": 26037,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868362,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Date of Birth",
"type": "DATE",
"value": null,
"displayName": "Date of Birth",
"masterAttributeId": 9436,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": true,
"displayCareSiteFlag": false
},
"attributeId": 2868365,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Keystone Card Proxy Number",
"type": "TEXT",
"value": null,
"displayName": "Keystone Card Proxy Number",
"masterAttributeId": 19957,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868367,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "First Time Card Issue",
"type": "BOOLEAN",
"value": "Yes",
"displayName": "First Time Card Issue",
"masterAttributeId": 4557,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868366,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Est Redemption Count",
"type": "FLOAT",
"value": "750",
"displayName": "Est Redemption Count",
"masterAttributeId": 16136,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868351,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Signature",
"type": "BOOLEAN",
"value": "true",
"displayName": "Signature on Rebate Form",
"masterAttributeId": 1736,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868350,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Program Code",
"type": "TEXT",
"value": "52545",
"displayName": "Project Number",
"masterAttributeId": 5076,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868349,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Original Rebate Form",
"type": "BOOLEAN",
"value": "true",
"displayName": "Original Rebate Form",
"masterAttributeId": 1496,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868347,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "State",
"type": "TEXT",
"value": "CT,DC,DE,FL,GA,MA,MD,ME,NH,NJ,NY,PA,RI,SC,VA,VT",
"displayName": "State",
"masterAttributeId": 54,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868346,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Purchase Location",
"type": "TEXT",
"value": null,
"displayName": "Purchase Location",
"masterAttributeId": 3,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868345,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Purchase Date",
"type": "DATE",
"value": null,
"displayName": "Purchase Date",
"masterAttributeId": 5,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868344,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Original Receipt",
"type": "BOOLEAN",
"value": "true",
"displayName": "Original Receipt",
"masterAttributeId": 9576,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 2868343,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "DCN",
"type": "TEXT",
"value": null,
"displayName": "DCN",
"masterAttributeId": 8,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868342,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Start Date",
"type": "DATE",
"value": "03-20-2020",
"displayName": "Start Date",
"masterAttributeId": 1,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 2868339,
"displayOrder": null
}
],
"products": [{
"id": 11594808,
"name": "6-Pack Product",
"displayName": "6-Pack Product",
"attributes": [{
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "UPC",
"type": "TEXT",
"value": null,
"displayName": "UPC",
"masterAttributeId": 1,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955820,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Brand Name",
"type": "TEXT",
"value": null,
"displayName": "Brand Name",
"masterAttributeId": 4335,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955821,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Brand Code",
"type": "TEXT",
"value": null,
"displayName": "Brand Code",
"masterAttributeId": 5054,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955822,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Purchase Price",
"type": "CURRENCY",
"value": null,
"displayName": "Purchase Price",
"masterAttributeId": 22,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955823,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Ounces",
"type": "TEXT",
"value": null,
"displayName": "Ounces",
"masterAttributeId": 5056,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955824,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "System_Config Web Display",
"type": "BOOLEAN",
"value": "No",
"displayName": "System_Config Web Display",
"masterAttributeId": 7680,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 12955825,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Product Category",
"type": "TEXT",
"value": "6",
"displayName": "Product Category",
"masterAttributeId": 1654,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 12955826,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Pack Size",
"type": "NUMBER",
"value": "6",
"displayName": "Pack Size",
"masterAttributeId": 4334,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955818,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Package Type",
"type": "TEXT",
"value": "Bottle,Can,Aluminum",
"displayName": "Package Type",
"masterAttributeId": 4336,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955819,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Brand",
"type": "TEXT",
"value": "",
"displayName": "Brand Family",
"masterAttributeId": 5055,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955817,
"displayOrder": null
}
],
"webDescription": "6-Pack Product"
}, {
"id": 11594807,
"name": "12 Pack Product",
"displayName": "12 Pack Product",
"attributes": [{
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Brand Code",
"type": "TEXT",
"value": null,
"displayName": "Brand Code",
"masterAttributeId": 5054,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955807,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Brand Name",
"type": "TEXT",
"value": null,
"displayName": "Brand Name",
"masterAttributeId": 4335,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955808,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "UPC",
"type": "TEXT",
"value": null,
"displayName": "UPC",
"masterAttributeId": 1,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955809,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Product Category",
"type": "TEXT",
"value": "12",
"displayName": "Product Category",
"masterAttributeId": 1654,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 12955810,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "System_Config Web Display",
"type": "BOOLEAN",
"value": "No",
"displayName": "System_Config Web Display",
"masterAttributeId": 7680,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 12955811,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Ounces",
"type": "TEXT",
"value": null,
"displayName": "Ounces",
"masterAttributeId": 5056,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955812,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Purchase Price",
"type": "CURRENCY",
"value": null,
"displayName": "Purchase Price",
"masterAttributeId": 22,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955813,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Brand",
"type": "TEXT",
"value": "",
"displayName": "Brand Family",
"masterAttributeId": 5055,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955814,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Package Type",
"type": "TEXT",
"value": "Bottle,Can,Aluminum",
"displayName": "Package Type",
"masterAttributeId": 4336,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955815,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "Pack Size",
"type": "NUMBER",
"value": "12",
"displayName": "Pack Size",
"masterAttributeId": 4334,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955816,
"displayOrder": null
}
],
"webDescription": "12 Pack Beer Product"
}, {
"id": 11594805,
"name": "Park and Company Web Entered Product",
"displayName": "PC Web Entered Product",
"attributes": [{
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "System_Config Web Display",
"type": "BOOLEAN",
"value": "No",
"displayName": "System_Config Web Display",
"masterAttributeId": 7680,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 12955803,
"displayOrder": null
}
],
"webDescription": "Park and Company Web Entered Product"
}, {
"id": 11594806,
"name": "Invalid UPC Product",
"displayName": "Invalid UPC Product",
"attributes": [{
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "System_Config Web Display",
"type": "BOOLEAN",
"value": "No",
"displayName": "System_Config Web Display",
"masterAttributeId": 7680,
"mustBeCapturedFlag": false,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": false,
"displayDataEntryFlag": false,
"displayConsumerFlag": false,
"displayCareSiteFlag": false
},
"attributeId": 12955804,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "UPC",
"type": "TEXT",
"value": null,
"displayName": "UPC",
"masterAttributeId": 1,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955805,
"displayOrder": null
}, {
"reverseKeyVerifyFlag": false,
"webSearchable": false,
"name": "UPC Found",
"type": "BOOLEAN",
"value": "false",
"displayName": "Invalid UPC",
"masterAttributeId": 3695,
"mustBeCapturedFlag": true,
"deDupableFlag": false,
"isUCIDFlag": false,
"isThirdPartyFlag": false,
"keyVerifyFlag": false,
"usageFlags": {
"displayConsumerCareFlag": true,
"displayDataEntryFlag": true,
"displayConsumerFlag": false,
"displayCareSiteFlag": true
},
"attributeId": 12955806,
"displayOrder": null
}
],
"webDescription": "Invalid UPC Product"
}
],
"webProperties": {
"displayStartDate": "03-20-2020",
"displayEndDate": "05-22-2020",
"validStartDate": "03-20-2020",
"validEndDate": "05-08-2020",
"promoCenterSetupId": 1140135,
"promoCenterId": 19,
"webDescription": "6-PACK OR 12-PACK REBATE",
"promoCenterName": "parkandcompanyrebates.com"
},
"campaignStatus": "OPEN",
"primaryOwnerName": "Park and Company",
"primarySponsorName": "Park and Company",
"resubmissionDays": 30,
"resubmissionAddress": "",
"customerServicePhone": "855-555-5555"
},
"type": "FULL"
}
{
"status": 404,
"error": "Not Found",
"message": "Campaign Code 20-99999 could not be found",
"path": "/campaigns/v1/read/12345/20-99999",
"timestamp": 1585624102163,
"campaignInfo": null,
"type": null
}
{
"timestamp": 1583953533827,
"status": 404,
"error": "Not Found",
"message": "No message available",
"path": "/campaigns/v1/raed/12345/20-99999",
}
{
"timestamp": 1583954143186,
"status": 400,
"error": "Bad Request",
"message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Integer'; nested exception is java.lang.NumberFormatException: For input string: \"3NUM2217\"",
"path": "/campaigns/v1/read/3NUM2217/20-99999",
}
{
"timestamp": 1583965560292,
"status": 500,
"error": "Internal Server Error",
"message": "Core Campaign Service did not send a response back",
"path": "/campaigns/v1/read/12345/20-99999",
}
{
"message": "Unauthorized"
}
{
"message": "User is not authorized to access this resource"
}
Updated over 4 years ago