Mark benefit usages as synchronized

Developing

POST

https://api.storyous.com/loyaltyAdvanced/byProvider/{provider}/benefitUsages/sync

Description

Marks loyalty benefit usages as synchronized.

This endpoint should be called by the partner after retrieving benefit usages via the GET /benefitUsages endpoint.

Each benefitUsage document is uniquely identified by the loyaltyOfferId of the accepted offer.
As input, use the loyaltyOfferIds you receive via webhook or retrieve through the GET loyalty benefit usages endpoint

Responses

On complete success, the API responds with 204.

On invalid request (malformed payload, missing required fields, etc.), the API responds with 400 Bad Request.

The response body contains a general error message describing the problem.

On partial success (some updates succeeded, some failed), the API responds with 207 Multi-Status.

The response body contains per-item results, each marked as success or failure, with an optional error message for failures.

Even if all updates individually failed, it will still return 207 Multi-Status

Callbacks

syncNotification

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢204No Content

application/json

Successfully updated synchronization status

Body

🟠400Bad Request

🟠401Unauthorized

🟢207Multiple status

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.storyous.com/loyaltyAdvanced/byProvider//benefitUsages/sync' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "loyaltyOfferIds": [
        "fc375aceec5eaec83aa2a39a",
        "fc375aceec5eaec83aa2a39b"
    ],
    "status": "success"
}'

Response Example

204 - Example 1

{
    "results": [
        {
            "loyaltyOfferIds": "fc375aceec5eaec83aa2a39a",
            "status": "failure",
            "message": "Provider not activated on store"
        },
        {
            "loyaltyOfferIds": "fc375aceec5eaec83aa2a39b",
            "status": "success"
        }
    ]
}

Get loyalty benefit usages

DataSync