Topics

loyalty_adjustment_transaction.create

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "internalReason": "Manual Adjustment",
        "notificationText": "Manual Store Adjustment",
        "status": "complete"
    },
    "resourceType": "loyalty_adjustment_transaction",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

loyalty_adjustment_transaction.update

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "internalReason": "Manual Adjustment",
        "notificationText": "Manual Store Adjustment",
        "status": "complete"
    },
    "resourceType": "loyalty_adjustment_transaction",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

loyalty_adjustment_transaction.delete

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 100,
        "date": "2025-06-18T05:31:46.915Z",
        "internalReason": "Manual Adjustment",
        "notificationText": "Manual Store Adjustment",
        "status": "complete"
    },
    "resourceType": "loyalty_adjustment_transaction",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

loyalty_customer.create

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "customer": {
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]",
        },
        "birthday": {
            "day": 10,
            "month": 3
        },
        "dateCreated": "2025-06-18T05:31:46.915Z",
        "dateEnrolled": "2025-06-18T05:31:46.915Z",
        "datePointsExpire": "2025-06-18T05:31:46.915Z",
        "dateTierEntered": "2025-06-18T05:31:46.915Z",
        "dateTierExpires": "2025-06-18T05:31:46.915Z",
        "isTierLocked": true,
        "minimumVipTierId": "123e4567-e89b-12d3-a456-426614174000",
        "points": {
            "balance": 100,
            "dateUpdated": "2025-06-18T05:31:46.915Z",
            "pending": 0,
            "spent": 0
        },
        "rewardsClaimed": 0,
        "status": "enrolled",
        "vipTierId": "123e4567-e89b-12d3-a456-426614174000",
        "vipTierName": "Gold"
    },
    "resourceType": "loyalty_customer",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

loyalty_customer.update

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "customer": {
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]",
        },
        "birthday": {
            "day": 10,
            "month": 3
        },
        "dateCreated": "2025-06-18T05:31:46.915Z",
        "dateEnrolled": "2025-06-18T05:31:46.915Z",
        "datePointsExpire": "2025-06-18T05:31:46.915Z",
        "dateTierEntered": "2025-06-18T05:31:46.915Z",
        "dateTierExpires": "2025-06-18T05:31:46.915Z",
        "isTierLocked": true,
        "minimumVipTierId": "123e4567-e89b-12d3-a456-426614174000",
        "points": {
            "balance": 100,
            "dateUpdated": "2025-06-18T05:31:46.915Z",
            "pending": 0,
            "spent": 0
        },
        "rewardsClaimed": 0,
        "status": "enrolled",
        "vipTierId": "123e4567-e89b-12d3-a456-426614174000",
        "vipTierName": "Gold"
    },
    "resourceType": "loyalty_customer",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

loyalty_customer.delete

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "customer": {
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]",
        },
        "birthday": {
            "day": 10,
            "month": 3
        },
        "dateCreated": "2025-06-18T05:31:46.915Z",
        "dateEnrolled": "2025-06-18T05:31:46.915Z",
        "datePointsExpire": "2025-06-18T05:31:46.915Z",
        "dateTierEntered": "2025-06-18T05:31:46.915Z",
        "dateTierExpires": "2025-06-18T05:31:46.915Z",
        "isTierLocked": true,
        "minimumVipTierId": "123e4567-e89b-12d3-a456-426614174000",
        "points": {
            "balance": 100,
            "dateUpdated": "2025-06-18T05:31:46.915Z",
            "pending": 0,
            "spent": 0
        },
        "rewardsClaimed": 0,
        "status": "enrolled",
        "vipTierId": "123e4567-e89b-12d3-a456-426614174000",
        "vipTierName": "Gold"
    },
    "resourceType": "loyalty_customer",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

loyalty_earning_transaction.create

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "action": "purchase",
        "amount": 100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "notificationText": "Placed an Order",
        "status": "complete",
        "remoteOrderId": "123456789",
    },
    "resourceType": "loyalty_earning_transaction",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

loyalty_earning_transaction.update

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "action": "purchase",
        "amount": 100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "notificationText": "Placed an Order",
        "status": "complete",
        "remoteOrderId": "123456789",
    },
    "resourceType": "loyalty_earning_transaction",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

loyalty_earning_transaction.delete

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "action": "purchase",
        "amount": 100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "notificationText": "Placed an Order",
        "status": "complete",
        "remoteOrderId": "123456789",
    },
    "resourceType": "loyalty_earning_transaction",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

loyalty_redemption_transaction.create

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": -100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "notificationText": "Converted Points",
        "reward": {
            "status": "issued",
            "type": "coupon",
            "coupon": {
                "status": "issued",
                "description": "$10 Off",
                "code": "OKRX-XXXXX-XXXX"
            }
        },
        "status": "complete"
    },
    "resourceType": "loyalty_redemption_transaction",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

loyalty_redemption_transaction.update

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": -100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "notificationText": "Converted Points",
        "reward": {
            "status": "issued",
            "type": "coupon",
            "coupon": {
                "status": "issued",
                "description": "$10 Off",
                "code": "OKRX-XXXXX-XXXX"
            }
        },
        "status": "complete"
    },
    "resourceType": "loyalty_redemption_transaction",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

loyalty_redemption_transaction.delete

{
    "resource": {
        "loyaltyCustomerId": "123e4567-e89b-12d3-a456-426614174000",
        "loyaltyTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": -100,
        "customer": {
            "email": "[email protected]",
            "customerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "date": "2025-06-18T05:31:46.915Z",
        "notificationText": "Converted Points",
        "reward": {
            "status": "issued",
            "type": "coupon",
            "coupon": {
                "status": "issued",
                "description": "$10 Off",
                "code": "OKRX-XXXXX-XXXX"
            }
        },
        "status": "complete"
    },
    "resourceType": "loyalty_redemption_transaction",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

quiz_response.create

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "quizResponseId": "123e4567-e89b-12d3-a456-426614174000",
        "quizId": "123e4567-e89b-12d3-a456-426614174000",
        "quizName": "Find your fit quiz",
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "channel": "on-site-embed",
        "customer":{
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]"
        },
        "emailMarketingOptIn": true,
        "order": {
            "remoteOrderId": "123456789"
        },
        "answeredQuestions": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "multi-select",
                "text": "Which colors do you usually wear?",
                "answer": [
                    "Red",
                    "Blue",
                    "Other"
                ],
                "customAnswerOptionText": "Other",
                "customAnswer": "Orange"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "single-select",
                "text": "Help us understand! Why did you choose to leave our site?",
                "answer": "Didn't find what I was looking for",
                "customAnswerOptionText": "Other"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "star",
                "text": "How would you rate our customer service?",
                "answer": 5
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "five-point",
                "text": "How was your online shopping experience?",
                "answer": 4
            }
        ],
        "recommendation":{
            "type": "conditional-outcomes",
            "outcomeType": "result",
            "outcomeId": "123e4567-e89b-12d3-a456-426614174000",
            "outcomeTitle": "These are our top recommendations for you!",
            "recommendedProducts": [
                {
                    "defaultRemoteVariantId": "1234567890123",
                    "remoteProductId": "1234567890123",
                    "remoteVariantIds": [
                        "1234567890123"
                    ]
                },
                {
                    "defaultRemoteVariantId": "1234567890123",
                    "remoteProductId": "1234567890123",
                    "remoteVariantIds": [
                        "1234567890123",
                        "1234567890123"
                    ]
                },
                {
                    "remoteProductId": "1234567890123"
                }
            ]
        },
        "reward": {
            "description": "$10 off your next order over $40",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX"
        }
    },
    "resourceType": "quiz_response",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

quiz_response.update

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "quizResponseId": "123e4567-e89b-12d3-a456-426614174000",
        "quizId": "123e4567-e89b-12d3-a456-426614174000",
        "quizName": "Find your fit quiz",
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "channel": "on-site-embed",
        "customer":{
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]"
        },
        "emailMarketingOptIn": true,
        "order": {
            "remoteOrderId": "123456789"
        },
        "answeredQuestions": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "multi-select",
                "text": "Which colors do you usually wear?",
                "answer": [
                    "Red",
                    "Blue",
                    "Other"
                ],
                "customAnswerOptionText": "Other",
                "customAnswer": "Orange"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "single-select",
                "text": "Help us understand! Why did you choose to leave our site?",
                "answer": "Didn't find what I was looking for",
                "customAnswerOptionText": "Other"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "star",
                "text": "How would you rate our customer service?",
                "answer": 5
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "five-point",
                "text": "How was your online shopping experience?",
                "answer": 4
            }
        ],
        "recommendation":{
            "type": "weighted-products",
            "recommendedProducts": [
                {
                    "points": 2,
                    "product": {
                        "remoteProductId": "1234567890123"
                    }
                },
                {
                    "points": 1,
                    "product": {
                        "defaultRemoteVariantId": "1234567890123",
                        "remoteProductId": "1234567890123",
                        "remoteVariantIds": [
                            "1234567890123"
                        ]
                    }
                },
                {
                    "points": 1,
                    "product": {
                        "remoteProductId": "1234567890123"
                    }
                }
            ],
            "runnerUpProducts": [
                {
                    "points": 2,
                    "product": {
                        "remoteProductId": "1234567890123"
                    }
                },
                {
                    "points": 1,
                    "product": {
                        "remoteProductId": "1234567890123"
                    }
                },
                {
                    "points": 1,
                    "product": {
                        "defaultRemoteVariantId": "1234567890123"
                        "remoteProductId": "1234567890123",
                        "remoteVariantIds: [
                            "1234567890123",
                            "1234567890123",
                            "1234567890123"
                        ]
                    }
                }
            ]
        },
        "reward": {
            "description": "$10 off your next order over $40",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX"
        }
    },
    "resourceType": "quiz_response",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

quiz_response.delete

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "quizResponseId": "123e4567-e89b-12d3-a456-426614174000",
        "quizId": "123e4567-e89b-12d3-a456-426614174000",
        "quizName": "Find your fit quiz",
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "channel": "on-site-embed",
        "customer":{
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]"
        },
        "emailMarketingOptIn": true,
        "order": {
            "remoteOrderId": "123456789"
        },
        "answeredQuestions": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "multi-select",
                "text": "Which colors do you usually wear?",
                "answer": [
                    "Red",
                    "Blue",
                    "Other"
                ],
                "customAnswerOptionText": "Other",
                "customAnswer": "Orange"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "single-select",
                "text": "Help us understand! Why did you choose to leave our site?",
                "answer": "Didn't find what I was looking for",
                "customAnswerOptionText": "Other"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "star",
                "text": "How would you rate our customer service?",
                "answer": 5
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "five-point",
                "text": "How was your online shopping experience?",
                "answer": 4
            }
        ],
        "recommendation":{
            "type": "weighted-tags",
            "recommendedProducts": [
                {
                    "points": 5,
                    "product": {
                        "remoteProductId": "1234567890123",
                        "tags": [
                            "red"
                        ]
                    }
                },
                {
                    "points": 2,
                    "product": {
                        "remoteProductId": "1234567890123",
                        "tags": [
                            "blue"
                        ]
                    }
                },
                {
                    "points": 2,
                    "product": {
                        "remoteProductId": "1234567890123",
                        "tags": [
                            "blue"
                        ]
                    }
                }
            ],
            "runnerUpProducts": [
                {
                    "points": 2,
                    "product": {
                        "remoteProductId": "1234567890123",
                        "tags": [
                            "blue"
                        ]
                    }
                },
                {
                    "points": 1,
                    "product": {
                        "remoteProductId": "1234567890123",
                        "tags": [
                            "green"
                        ]
                    }
                },
                {
                    "points": 1,
                    "product": {
                        "remoteProductId": "1234567890123",
                        "tags": [
                            "purple"
                        ]
                    }
                }
            ],
            "tagPoints: [
                {
                    "points": 5,
                    "tag": "red"
                },
                {
                    "points": 2,
                    "tag": "blue"
                },
                {
                    "points": 1,
                    "tag": "green"
                },
                {
                    "points": 1,
                    "tag": "purple"
                }
            ]
        },
        "reward": {
            "description": "$10 off your next order over $40",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX"
        }
    },
    "resourceType": "quiz_response",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

review.create

{

    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "reviewId": "123e4567-e89b-12d3-a456-426614174000",
        "productId": "shopify-123456789",
        "attributesWithRating": [
            {
                "minLabel": "Too Small",
                "midLabel": "Just Right",
                "maxLabel": "Too Big",
                "title": "Sizing",
                "type": "centered-range",
                "value": 1
            }
        ],
        "body": "Great quality and price! Would buy again!",
        "containsProfanity": true,
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "helpfulCount": 1,
        "isRecommended": true,
        "media": [
            {
                "streamId": "123e4567-e89b-12d3-a456-426614174000",
                "fullSizeUrl": "https://example.com",
                "largeUrl": "https://example.com",
                "thumbnailUrl": "https://example.com",
                "type": "image",
                "isHidden": true
            }
        ],
        "productAttributes": [
            {
                "title": "Pros",
                "type": "drop-down",
                "value": "Powerful"
            }
        ],
        "productName": "Laptop Pro",
        "order": {
            "orderId": "123456789",
            "orderNumber": "#OKRXXXX"
        },
        "rating": 5,
        "reply": {
            "body": "<p><b>Thanks</b> for your review</p>",
            "dateCreated": "2025-03-24T07:32:17.872Z",
            "rawBody": "*Thanks* for your review",
            "isPrivate": true
        },
        "reviewer": {
            "attributes": [
                {
                    "title": "Pros",
                    "type": "drop-down",
                    "value": "Powerful"
                }
            ],
            "avatarUrl": "https://example.com",
            "displayName": "Alex S.",
            "email": "[email protected]",
            "isVerified": true,
            "location": {
                "country": {
                    "code": "au",
                    "name": "Australia"
                },
                "zoneCode": "NSW"
            },
            "name": "Alex Stevens",
            "socialConnection": "facebook",
            "verifiedStatus": "Verified Buyer"
        },
        "reward": {
            "description": "$10 off your next order over $40",
            "integration": "rewardsPlatform",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX",
            "isCouponUpgrade": true
        },
        "sentiment": "positive",
        "status": "approved",
        "tags": [
            "Support Needed",
            "Favourite"
        ],
        "title": "Fantastic product!",
        "unhelpfulCount": 1,
        "variantId": "1234567890",
        "variantName": "Laptop Pro - 15 Inch"
    },
    "resourceType": "review",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

review.update

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "reviewId": "123e4567-e89b-12d3-a456-426614174000",
        "productId": "shopify-123456789",
        "attributesWithRating": [
            {
                "minLabel": "Too Small",
                "midLabel": "Just Right",
                "maxLabel": "Too Big",
                "title": "Sizing",
                "type": "centered-range",
                "value": 1
            }
        ],
        "body": "Great quality and price! Would buy again!",
        "containsProfanity": true,
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "helpfulCount": 1,
        "isRecommended": true,
        "media": [
            {
                "streamId": "123e4567-e89b-12d3-a456-426614174000",
                "fullSizeUrl": "https://example.com",
                "largeUrl": "https://example.com",
                "thumbnailUrl": "https://example.com",
                "type": "image",
                "isHidden": true
            }
        ],
        "productAttributes": [
            {
                "title": "Pros",
                "type": "drop-down",
                "value": "Powerful"
            }
        ],
        "productName": "Laptop Pro",
        "order": {
            "orderId": "123456789",
            "orderNumber": "#OKRXXXX"
        },
        "rating": 5,
        "reply": {
            "body": "<p><b>Thanks</b> for your review</p>",
            "dateCreated": "2025-03-24T07:32:17.872Z",
            "rawBody": "*Thanks* for your review",
            "isPrivate": true
        },
        "reviewer": {
            "attributes": [
                {
                    "title": "Pros",
                    "type": "drop-down",
                    "value": "Powerful"
                }
            ],
            "avatarUrl": "https://example.com",
            "displayName": "Alex S.",
            "email": "[email protected]",
            "isVerified": true,
            "location": {
                "country": {
                    "code": "au",
                    "name": "Australia"
                },
                "zoneCode": "NSW"
            },
            "name": "Alex Stevens",
            "socialConnection": "facebook",
            "verifiedStatus": "Verified Buyer"
        },
        "reward": {
            "description": "$10 off your next order over $40",
            "integration": "rewardsPlatform",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX",
            "isCouponUpgrade": true
        },
        "sentiment": "positive",
        "status": "approved",
        "tags": [
            "Support Needed",
            "Favourite"
        ],
        "title": "Fantastic product!",
        "unhelpfulCount": 1,
        "variantId": "1234567890",
        "variantName": "Laptop Pro - 15 Inch"
    },
    "resourceType": "review",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

review.delete

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "reviewId": "123e4567-e89b-12d3-a456-426614174000",
        "productId": "shopify-123456789",
        "attributesWithRating": [
            {
                "minLabel": "Too Small",
                "midLabel": "Just Right",
                "maxLabel": "Too Big",
                "title": "Sizing",
                "type": "centered-range",
                "value": 1
            }
        ],
        "body": "Great quality and price! Would buy again!",
        "containsProfanity": true,
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "helpfulCount": 1,
        "isRecommended": true,
        "media": [
            {
                "streamId": "123e4567-e89b-12d3-a456-426614174000",
                "fullSizeUrl": "https://example.com",
                "largeUrl": "https://example.com",
                "thumbnailUrl": "https://example.com",
                "type": "image",
                "isHidden": true
            }
        ],
        "productAttributes": [
            {
                "title": "Pros",
                "type": "drop-down",
                "value": "Powerful"
            }
        ],
        "productName": "Laptop Pro",
        "order": {
            "orderId": "123456789",
            "orderNumber": "#OKRXXXX"
        },
        "rating": 5,
        "reply": {
            "body": "<p><b>Thanks</b> for your review</p>",
            "dateCreated": "2025-03-24T07:32:17.872Z",
            "rawBody": "*Thanks* for your review",
            "isPrivate": true
        },
        "reviewer": {
            "attributes": [
                {
                    "title": "Pros",
                    "type": "drop-down",
                    "value": "Powerful"
                }
            ],
            "avatarUrl": "https://example.com",
            "displayName": "Alex S.",
            "email": "[email protected]",
            "isVerified": true,
            "location": {
                "country": {
                    "code": "au",
                    "name": "Australia"
                },
                "zoneCode": "NSW"
            },
            "name": "Alex Stevens",
            "socialConnection": "facebook",
            "verifiedStatus": "Verified Buyer"
        },
        "reward": {
            "description": "$10 off your next order over $40",
            "integration": "rewardsPlatform",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX",
            "isCouponUpgrade": true
        },
        "sentiment": "positive",
        "status": "approved",
        "tags": [
            "Support Needed",
            "Favourite"
        ],
        "title": "Fantastic product!",
        "unhelpfulCount": 1,
        "variantId": "1234567890",
        "variantName": "Laptop Pro - 15 Inch"
    },
    "resourceType": "review",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

survey_response.create

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyResponseId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyName": "Website Experience",
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "channel": "post-checkout",
        "channelSurveyId": "123e4567-e89b-12d3-a456-426614174000",
        "channelSurveyDescription": "New customers purchasing product X",
        "customer":{
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]"
        },
        "order": {
            "remoteOrderId": "123456789"
        },
        "answeredQuestions": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "multi-select",
                "text": "Which colors do you usually wear?",
                "answer": [
                    "Red",
                    "Blue",
                    "Other"
                ],
                "customAnswerOptionText": "Other",
                "customAnswer": "Orange"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "single-select",
                "text": "Help us understand! Why did you choose to leave our site?",
                "answer": "Didn't find what I was looking for",
                "customAnswerOptionText": "Other"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "star",
                "text": "How would you rate our customer service?",
                "answer": 5
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "five-point",
                "text": "How was your online shopping experience?",
                "answer": 4
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "nps",
                "text": "How likely is it that you would recommend us to a friend or colleague?",
                "answer": 8,
                "answerNpsCategory": "passive"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "text": "Any other comments?",
                "answer": "I can't find a shirt in my size."
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "email",
                "text": "What's your email address?",
                "answer": "[email protected]",
                "marketingOptIn": true
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "What are your skin concerns?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "multi-value",
                    "value": [
                        "Pigmentation",
                        "Redness",
                        "Sensitivity"
                    ]
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "How old are you?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "single-value",
                    "value": "25-34"
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "Where do you live, country and zone?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "location",
                    "value": {
                        "countryCode": "BD"
                    }
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "When is your birthday?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer": {
                    "type": "date-components",
                    "value": {
                        "day": 1,
                        "month": 1
                    }
                }
            }
        ],
        "reward": {
            "description": "$10 off your next order over $40",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX"
        }
    },
    "resourceType": "survey_response",
    "sequenceNumber": "123123412",
    "topic": "create",
    "version": "2025-02-01"
}

survey_response.update

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyResponseId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyName": "Website Experience",
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "channel": "post-checkout",
        "channelSurveyId": "123e4567-e89b-12d3-a456-426614174000",
        "channelSurveyDescription": "New customers purchasing product X",
        "customer":{
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]"
        },
        "order": {
            "remoteOrderId": "123456789"
        },
        "answeredQuestions": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "multi-select",
                "text": "Which colors do you usually wear?",
                "answer": [
                    "Red",
                    "Blue",
                    "Other"
                ],
                "customAnswerOptionText": "Other",
                "customAnswer": "Orange"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "single-select",
                "text": "Help us understand! Why did you choose to leave our site?",
                "answer": "Didn't find what I was looking for",
                "customAnswerOptionText": "Other"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "star",
                "text": "How would you rate our customer service?",
                "answer": 5
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "five-point",
                "text": "How was your online shopping experience?",
                "answer": 4
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "nps",
                "text": "How likely is it that you would recommend us to a friend or colleague?",
                "answer": 8,
                "answerNpsCategory": "passive"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "text": "Any other comments?",
                "answer": "I can't find a shirt in my size."
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "email",
                "text": "What's your email address?",
                "answer": "[email protected]",
                "marketingOptIn": true
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "What are your skin concerns?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "multi-value",
                    "value": [
                        "Pigmentation",
                        "Redness",
                        "Sensitivity"
                    ]
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "How old are you?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "single-value",
                    "value": "25-34"
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "Where do you live, country and zone?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "location",
                    "value": {
                        "countryCode": "BD"
                    }
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "When is your birthday?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer": {
                    "type": "date-components",
                    "value": {
                        "day": 1,
                        "month": 1
                    }
                }
            }
        ],
        "reward": {
            "description": "$10 off your next order over $40",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX"
        }
    },
    "resourceType": "survey_response",
    "sequenceNumber": "123123412",
    "topic": "update",
    "version": "2025-02-01"
}

survey_response.delete

{
    "resource": {
        "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyResponseId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyId": "123e4567-e89b-12d3-a456-426614174000",
        "surveyName": "Website Experience",
        "dateCreated": "2025-03-24T07:32:17.872Z",
        "channel": "post-checkout",
        "channelSurveyId": "123e4567-e89b-12d3-a456-426614174000",
        "channelSurveyDescription": "New customers purchasing product X",
        "customer":{
            "customerId": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]"
        },
        "order": {
            "remoteOrderId": "123456789"
        },
        "answeredQuestions": [
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "multi-select",
                "text": "Which colors do you usually wear?",
                "answer": [
                    "Red",
                    "Blue",
                    "Other"
                ],
                "customAnswerOptionText": "Other",
                "customAnswer": "Orange"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "single-select",
                "text": "Help us understand! Why did you choose to leave our site?",
                "answer": "Didn't find what I was looking for",
                "customAnswerOptionText": "Other"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "star",
                "text": "How would you rate our customer service?",
                "answer": 5
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "five-point",
                "text": "How was your online shopping experience?",
                "answer": 4
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "nps",
                "text": "How likely is it that you would recommend us to a friend or colleague?",
                "answer": 8,
                "answerNpsCategory": "passive"
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "text": "Any other comments?",
                "answer": "I can't find a shirt in my size."
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "email",
                "text": "What's your email address?",
                "answer": "[email protected]",
                "marketingOptIn": true
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "What are your skin concerns?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "multi-value",
                    "value": [
                        "Pigmentation",
                        "Redness",
                        "Sensitivity"
                    ]
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "How old are you?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "single-value",
                    "value": "25-34"
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "Where do you live, country and zone?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer":{
                    "type": "location",
                    "value": {
                        "countryCode": "BD"
                    }
                }
            },
            {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "type": "profile",
                "text": "When is your birthday?",
                "profileQuestionId": "123e4567-e89b-12d3-a456-426614174000",
                "answer": {
                    "type": "date-components",
                    "value": {
                        "day": 1,
                        "month": 1
                    }
                }
            }
        ],
        "reward": {
            "description": "$10 off your next order over $40",
            "type": "coupon",
            "value": "OKRX-XXXXX-XXXX"
        }
    },
    "resourceType": "survey_response",
    "sequenceNumber": "123123412",
    "topic": "delete",
    "version": "2025-02-01"
}

referral.create

{
    "resource": {
        "channel": "on-site",
        "dateCreated": "2025-11-04T04:37:38.079Z",
        "localeCode": "en-US",
        "recipient": {
            "customerId": "ac74dbb1-b420-4276-8e4b-3659d5ce3833",
            "email": "[email protected]",
            "status": "invited",
            "statusHistory": [
                {
                    "date": "2025-11-04T04:37:38.079Z",
                    "status": "invited"
                }
            ]
        },
        "referralId": "77c73dfc-fd02-4fc1-9597-2b5a49a4a7e3",
        "sender": {
            "customerId": "9fb076d1-aa1a-41bd-ba6f-c8ee6bd1e0a0",
            "email": "[email protected]",
            "status": "awaiting-recipient-order",
            "statusHistory": [
                {
                    "date": "2025-11-04T04:37:38.079Z",
                    "status": "awaiting-recipient-order"
                }
            ]
        },
        "source": "email",
        "subscriberId": "2c49b59d-d728-47da-94dd-613b89ccbb0b"
    },
    "resourceType": "referral",
    "sequenceNumber": "4600756000000592691356915672",
    "topic": "create",
    "version": "2025-02-01"
}

referral.update

{
    "resource": {
        "channel": "on-site",
        "dateCreated": "2025-10-31T01:54:42.893Z",
        "localeCode": "en",
        "recipient": {
            "customerId": "a5b6b7c1-1ee5-4dc5-9580-77f54c4d50ee",
            "email": "[email protected]",
            "issuedReward": {
                "code": "OKRJ-CFY2Y-MUGG",
                "description": "10% off your first order",
                "expiryDate": "2025-11-30T01:54:46.114Z",
                "type": "coupon",
                "value": {
                    "value": 10,
                    "valueType": "percentage"
                }
            },
            "order": {
                "orderDiscountAmount": 16,
                "orderId": "shopify-5669829509253",
                "orderNumber": "#1113",
                "orderTotalPrice": 158.4
            },
            "status": "order-placed",
            "statusHistory": [
                {
                    "date": "2025-10-31T01:54:42.893Z",
                    "status": "invited"
                },
                {
                    "date": "2025-10-31T01:55:34.733Z",
                    "status": "identified"
                },
                {
                    "date": "2025-10-31T01:55:38.637Z",
                    "status": "coupon-issued"
                },
                {
                    "date": "2025-10-31T01:58:04.907Z",
                    "status": "order-placed"
                }
            ]
        },
        "referralId": "d6de8d7e-9da6-42eb-9ad9-7e7a8f23157b",
        "sender": {
            "customerId": "eba5c3e8-db82-41ab-9747-6b35cca28078",
            "email": "[email protected]",
            "issuedReward": {
                "type": "none"
            },
            "status": "coupon-issued",
            "statusHistory": [
                {
                    "date": "2025-10-31T01:54:42.893Z",
                    "status": "awaiting-recipient-order"
                },
                {
                    "date": "2025-10-31T01:58:04.907Z",
                    "status": "awaiting-coupon-delay"
                },
                {
                    "date": "2025-10-31T01:58:21.766Z",
                    "status": "coupon-issued"
                }
            ]
        },
        "source": "shareable-link",
        "subscriberId": "f843f629-3fdd-49b1-845a-6bfa37dd311b"
    },
    "resourceType": "referral",
    "sequenceNumber": "4543935900003604676094650312",
    "topic": "update",
    "version": "2025-02-01"
}

referral.delete

{
    "resource": {
        "channel": "on-site",
        "dateCreated": "2025-10-31T01:54:42.893Z",
        "localeCode": "en",
        "recipient": {
            "customerId": "a5b6b7c1-1ee5-4dc5-9580-77f54c4d50ee",
            "email": "[email protected]",
            "issuedReward": {
                "code": "OKRJ-CFY2Y-MUGG",
                "description": "10% off your first order",
                "expiryDate": "2025-11-30T01:54:46.114Z",
                "type": "coupon",
                "value": {
                    "value": 10,
                    "valueType": "percentage"
                }
            },
            "order": {
                "orderDiscountAmount": 16,
                "orderId": "shopify-5669829509253",
                "orderNumber": "#1113",
                "orderTotalPrice": 158.4
            },
            "status": "order-placed",
            "statusHistory": [
                {
                    "date": "2025-10-31T01:54:42.893Z",
                    "status": "invited"
                },
                {
                    "date": "2025-10-31T01:55:34.733Z",
                    "status": "identified"
                },
                {
                    "date": "2025-10-31T01:55:38.637Z",
                    "status": "coupon-issued"
                },
                {
                    "date": "2025-10-31T01:58:04.907Z",
                    "status": "order-placed"
                }
            ]
        },
        "referralId": "d6de8d7e-9da6-42eb-9ad9-7e7a8f23157b",
        "sender": {
            "customerId": "eba5c3e8-db82-41ab-9747-6b35cca28078",
            "email": "[email protected]",
            "issuedReward": {
                "type": "none"
            },
            "status": "coupon-issued",
            "statusHistory": [
                {
                    "date": "2025-10-31T01:54:42.893Z",
                    "status": "awaiting-recipient-order"
                },
                {
                    "date": "2025-10-31T01:58:04.907Z",
                    "status": "awaiting-coupon-delay"
                },
                {
                    "date": "2025-10-31T01:58:21.766Z",
                    "status": "coupon-issued"
                }
            ]
        },
        "source": "shareable-link",
        "subscriberId": "f843f629-3fdd-49b1-845a-6bfa37dd311b"
    },
    "resourceType": "referral",
    "sequenceNumber": "4543935900003604676094650312",
    "topic": "delete",
    "version": "2025-02-01"
}