Schema
Overview
A CMOR object is the result of a Consumer Match on a set of partners that has a live CLO campaign with Banyan. It is a combination of five objects:
- Consumer
- Receipt
- Offer
- Offer Activation (Optional)
- Result
CMOR Top Level
| Element | Description | Data Type | Nullable? | Notes |
|---|---|---|---|---|
| id | Banyan generated ID when an offer redemption is created for a consumer match during a CLO campaign | String | no | |
| fulfillment_count | The number of times this user/card has had a reward for this offer before this current redemption | Integer | no | Note, the first time a user is rewarded this will be "0" |
| campaign | Object | |||
| offer_activation | Object | |||
| offer | Object | |||
| consumer_match | Object | |||
| result | Object |
cmor.campaign
See retail receipt schema here
cmor.offer_activation
See offer_activation schema here
cmor.offer
See offer schema here
cmor.consumer_match
See consumer_match schema here
cmor.result
| Element | Description | Data Type | Nullable? | Notes |
|---|---|---|---|---|
| hotel | Object | yes | ||
| item | Object | yes | ||
| fulfilled | Whether there was at least one item/hotel item that qualified for the offer | Boolean | no | |
| cumulative_qualified_total_amount | The total amount of the items that qualified across item and hotel | String | no | |
| amount_back | The calculated amount back based on the offer details and the cumulative qualified total amount | String | no |
cmor.result.hotel
| Element | Description | Data Type | Nullable? | Notes |
|---|---|---|---|---|
| qualified_dining_charges | The IDs of dining charges with qualified tags | String | yes | |
| unqualified_dining_charges | The IDs of dining charges without qualified tags | String | yes | |
| total_qualified_dining_spend | The amount of dining charges that have qualified tags | String | yes | |
| qualified_room_charges | The IDs of room charges with qualified tags | String | yes | |
| unqualified_room_charges | The IDs of room charges without qualified tags | String | yes | |
| total_qualified_room_charges | The amount of room charges that have qualified tags | String | yes |
cmor.result.item
| Element | Description | Data Type | Nullable? | Notes |
|---|---|---|---|---|
| unqualified_ids | The IDs of items with qualified tags | String | yes | |
| qualified_ids | The IDs of items without qualified tags | String | yes | |
| qualified_total_amount | The amount paid that corresponds to the qualified ids | String | yes |
CMX Example
{
"fulfillment_count": 3,
"created_ts": "2025-06-08T20:06:51.322Z",
"id": "4142a066-662c-4c64-ad59-9221833581a2",
"campaign": {
"budget": 0,
"byn_publisher_id": 316,
"created_ts": "2024-08-15T21:32:04.131Z",
"updated_ts": "2024-08-15T21:32:04.131Z",
"byn_campaign_id": "74567b52-18ca-5974-bb30-8d67830ee080",
"name": "Test campaign"
},
"offer_activation": null,
"offer": {
"card_types": null,
"budget": 0,
"start_ts": "2024-08-26T12:00:00.000Z",
"return_receipt_detail": true,
"amount_back_per_unit": "0.0000",
"prorate_qualified_spend": false,
"byn_advertiser_id": 327,
"name": "082624: Store 2.5% On Non Private Label Items",
"amount_back_type": "DOLLAR",
"amount_back_limit": "0.00",
"activation_window_minutes": null,
"offer_criteria": {
"order_types": ["any"],
"item_qualification_expression": "\"PRIVATE_LABEL_IND:|:N\"",
"amount_threshold": "0.00",
"item_disqualification_expression": "\"excluded:|:excluded item\"",
"incl_sku": [],
"excl_tags": ["excluded:|:excluded item"],
"excl_sku": [],
"fulfillment_count_limit": 0,
"incl_tags": ["PRIVATE_LABEL_IND:|:N"]
},
"created_ts": "2024-08-15T21:38:00.568Z",
"amount_back_per_dollar": "0.0250",
"always_on": true,
"byn_publisher_id": 316,
"allow_activation_after_purchase": true,
"card_issuer": "",
"offer_hotel_criteria": null,
"currency": "",
"expiration_ts": "2026-08-15T21:59:00.000Z",
"updated_ts": "2025-02-14T21:40:29.706Z",
"byn_offer_id": "70770c15-0d5b-5e74-89e7-da17a7c19d49",
"publisher_offer_id": "08262024B"
},
"consumer_match": {
"finx_consumer_token": "2ddf2275-3ebd-4198-83ec-c23fed2924fa",
"receipt": {
"custom_fields": null,
"currency": "USD",
"payment": {
"other_negative_amounts": "0.00",
"card_issuer": "",
"payment_type": "CREDIT",
"is_virtual_card": null,
"other_positive_amounts": "0.00",
"cash_back_amount": "0.00",
"shipping_amount": "0.00",
"subtotal_amount": "40.46",
"tax_amount": "2.55",
"payment_account_reference": "V0010013017276763286104025655",
"total_amount": "43.01",
"scheme": "VI",
"tip_amount": "0.00",
"auth_code": "47888D"
},
"order_ts": null,
"fulfillment_type": "in_store",
"merchant_receipt_id": "5060503",
"hotel": null,
"image_url": "",
"purchase_ts": "2025-06-05T20:38:05.000Z",
"barcode_url": "",
"merchant_mid": "3109010095067",
"location": {
"card_acceptor_names": ["Stores#9506"],
"display_name": "",
"phone_number": "",
"address": {
"address_line_one": "770 E SCHAUMBURG RD",
"address_line_two": "",
"city": "SCHAUMBURG",
"state": "IL",
"country": "US",
"postal_code": "60194"
},
"merchant_store_id": "9506",
"name": "Store SCHAUMBURG"
},
"order_type": "in_store",
"merchant_total_amount": "43.01",
"byn_receipt_id": "8ec63448-2af6-5f91-a066-2ee97681ac9f",
"merchant": {
"name": "store"
},
"received_ts": "2025-06-08T19:17:09.485Z",
"items": [
{
"quantity": "1.00",
"brand": "MRS MEYERS",
"full_price_per_unit": "5.99",
"description": "MRS MEYERS LHS HONEYSUCKLE 12.5OZ",
"discount_price_per_unit": "5.99",
"byn_item_id": "2a6830fa-cad9-5007-a5dc-d5b0bdad94c3",
"sku": "6546177",
"amount_paid": "5.99",
"tags": [
"mdse_cat_name:|:BATH",
"MDSE_DIV_NAME:|:PERSNL CARE",
"PRIVATE_LABEL_IND:|:N",
"OPS_DEPT_NAME:|:BATH & SOAP",
"category_id:|:206012",
"category_name:|:BATH/SOAP - HAND SOAP206012",
"item_description:|:MRS MEYERS LHS HONEYSUCKLE 12.5OZ",
"fsa_item_ind:|:N"
],
"merchant_item_id": "",
"upc": "808124174252",
"image_url": "",
"unit_type": "each"
},
{
"discount_price_per_unit": "15.00",
"quantity": "1.00",
"unit_type": "each",
"merchant_item_id": "",
"brand": "",
"amount_paid": "15.00",
"byn_item_id": "393500ae-7089-5daa-b9e6-622874e8816e",
"description": "Excluded Items",
"full_price_per_unit": "15.00",
"upc": "999999999999",
"tags": ["excluded:|:excluded item"],
"sku": "",
"image_url": ""
},
{
"brand": "",
"full_price_per_unit": "0.00",
"merchant_item_id": "",
"image_url": "",
"discount_price_per_unit": "0.00",
"quantity": "1.00",
"byn_item_id": "393500ae-7089-5daa-b9e6-622874e8816e",
"upc": "999999999999",
"sku": "",
"description": "Excluded Items",
"unit_type": "each",
"amount_paid": "0.00",
"tags": ["excluded:|:excluded item"]
},
{
"quantity": "1.00",
"image_url": "",
"full_price_per_unit": "5.99",
"tags": [
"mdse_cat_name:|:BATH",
"MDSE_DIV_NAME:|:PERSNL CARE",
"PRIVATE_LABEL_IND:|:N",
"OPS_DEPT_NAME:|:BATH & SOAP",
"category_id:|:206012",
"category_name:|:BATH/SOAP - HAND SOAP206012",
"item_description:|:MRS MEYERS LHS LAVENDER 12.5OZ",
"fsa_item_ind:|:N"
],
"merchant_item_id": "",
"upc": "808124111042",
"brand": "MRS MEYERS",
"description": "MRS MEYERS LHS LAVENDER 12.5OZ",
"discount_price_per_unit": "5.99",
"unit_type": "each",
"byn_item_id": "b21b0ebe-1146-52ed-8a4b-e765f8ef6b9c",
"sku": "6380940",
"amount_paid": "5.99"
},
{
"byn_item_id": "1367fc52-9d96-5d19-920c-15edb3bb1aa8",
"sku": "6380943",
"tags": [
"mdse_cat_name:|:BATH",
"MDSE_DIV_NAME:|:PERSNL CARE",
"PRIVATE_LABEL_IND:|:N",
"OPS_DEPT_NAME:|:BATH & SOAP",
"category_id:|:206012",
"category_name:|:BATH/SOAP - HAND SOAP206012",
"item_description:|:MRS MEYERS LHS LEMON 12.5OZ",
"fsa_item_ind:|:N"
],
"upc": "808124121041",
"amount_paid": "5.99",
"full_price_per_unit": "5.99",
"unit_type": "each",
"discount_price_per_unit": "5.99",
"merchant_item_id": "",
"brand": "MRS MEYERS",
"quantity": "1.00",
"image_url": "",
"description": "MRS MEYERS LHS LEMON 12.5OZ"
},
{
"description": "DRANO LIQ PROF STRGTH MAX GL 32OZ",
"unit_type": "each",
"byn_item_id": "b6cf2da6-08e5-55a1-9fec-cd84b4310077",
"brand": "DRANO",
"full_price_per_unit": "7.49",
"tags": [
"mdse_cat_name:|:HSHLD CLNR",
"MDSE_DIV_NAME:|:HHLD&GROCERY",
"PRIVATE_LABEL_IND:|:N",
"OPS_DEPT_NAME:|:CLEANING & POLISHING",
"category_id:|:42008",
"category_name:|:CLEAN/POLISH - DRAIN042008",
"item_description:|:DRANO LIQ PROF STRGTH MAX GL 32OZ",
"fsa_item_ind:|:N"
],
"sku": "2914714",
"discount_price_per_unit": "7.49",
"quantity": "1.00",
"upc": "019800001179",
"amount_paid": "7.49",
"merchant_item_id": "",
"image_url": ""
}
]
},
"byn_cmx_id": "ca799c91-f02d-55cd-9e85-4068ea48ab53",
"match_ts": "2025-06-08T20:06:49.621Z"
},
"result": {
"hotel": {
"qualified_dining_charges": null,
"unqualified_dining_charges": null,
"total_qualified_dining_spend": "0.0000",
"qualified_room_charges": null,
"unqualified_room_charges": null,
"total_qualified_room_spend": "0.0000"
},
"items": {
"unqualified_ids": [
"393500ae-7089-5daa-b9e6-622874e8816e",
"393500ae-7089-5daa-b9e6-622874e8816e"
],
"qualified_total_amount": "25.46",
"qualified_ids": [
"2a6830fa-cad9-5007-a5dc-d5b0bdad94c3",
"b21b0ebe-1146-52ed-8a4b-e765f8ef6b9c",
"1367fc52-9d96-5d19-920c-15edb3bb1aa8",
"b6cf2da6-08e5-55a1-9fec-cd84b4310077"
]
},
"fulfilled": true,
"cumulative_qualified_total_amount": "25.4600",
"amount_back": "0.64"
}
}
Updated 6 days ago