Using PLUs for Offer Validation

Modified on Thu, 28 Sep, 2023 at 3:37 PM

PLUs (price look up codes) can be use for AI (8112) offer validation in the AI (8112) eco-system. In order to protect the the quality of the Master Offer File, PLUs must use their own designated field within the Master Offer File. Each group of PLUs is assigned to a retailer within the input field to avoid accidental misrepresentation from one retailer to another.

The PLU field is not a default field in the Master Offer File and has to be authorized for use at the account level by TCB administration.

Attributes of the primary_purchase_prefix_code field within Master Offer File Detail:

Note: Class and Department are not currently supported in the US market.

primary_purchase_prefixed_code

array

Optional. All qualified PLU (Prefix PLU), Class (Prefix CLS), Department (Prefix Dept) or ClassAndDepartment (Prefix C_D). As these are retailer specific, you need to include retailer email domain also along with the prefix. The format is <Prefix>:<Retailer Email Domain>:<Values separated by hyphen>. E.g. ["PLU:example.com:6278-101-102", "PLU:example1.com:988-123", "CLS:example.com:237"]. If the value is applicable for all retailers, use "all" instead of retailer email domain.

Sample Redemption Response Body:

{
    "status": "success",
    "total_gs1s_processed": 1,
    "newly_redeemed": [
        {
            "gs1": "8112101119998715239819377160213878",
            "master_offer_file": "811210111999871523",
            "stakeholders_email_domain": [
                "catalinajapan:retailer",
                "catalinatest.catalinajapan:manufacturer",
                "catalinajapan:authorized_partner",
                "catalinajapan:provider"
            ]
        }
    ],
    "master_offer_files": {
        "811210111999871523": {
            "primary_purchase_save_value": 20,
            "primary_purchase_requirements": 1,
            "primary_purchase_req_code": 0,
            "additional_purchase_rules_code": 1,
            "second_purchase_requirements": 1,
            "second_purchase_gs1_company_prefix": 19128,
            "second_purchase_req_code": 1,
            "third_purchase_requirements": 2,
            "third_purchase_gs1_company_prefix": 3294,
            "third_purchase_req_code": 2,
            "save_value_code": 1,
            "applies_to_which_item": 1,
            "donot_multiply_flag": 1,
            "funder_id": "111999",
            "offer_code": "871523",
            "primary_purchase_prefixed_code": {
                "PLU": [
                    "40",
                    "50"
                ],
            },
            
    "message": "Redeemed 1 gs1(s)",
    "status_code": "FULL_REDEMPTION",
    "event_timestamp": 1688727865178,
    "pre_process": "yes",
    "emailDomain": "catalinajapan",
    "execution_time_in_ms": 163,
    "execution_start_time": 1688727865178,
    "execution_id": "add55ad7-c6fb-4d0f-9d87-922a68dd7f14"
}