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"
}

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"
}

PreviousGetting Started

Last updated 8 days ago