Cancel Loyalty Order

Purpose

When an order is cancelled. Deliverect sends an event to the configured endpoint, including the key order identifier "orderId" along with a cancellation reason where provided. This enables the Loyalty platform to perform relevant follow-up actions, such as reversing awarded loyalty points or reinstating redeemed points.

Payload

{
    "orderId": "63********************a7",
    "loyaltyProfileId": "63********************a7",
    "accountId": "6403c0b9ea6956b6f6970c5b",
    "locationId": "61********************b4",
    "channelLinkId": "61********************c3",
    "channelOrderDisplayId": "TESTORDER1",
    "isCancelled": true,
    "cancellationReason": "Customer cancelled.",
    "customer": {
        "email": "[email protected]",
        "phoneNumber": "+32111111111",
        "loyaltyProviderCustomerId": "123",
        "name": "John Doe"
    }
}
Attribute nameTypeDescription
orderIdstringIdentifier of the order
accountIdstringThe merchant's account Id in Deliverect
loyaltyProfileIdstringThe Id of the profile where the response configuration was stored
locationIdstringThe merchant's location Id in Deliverect
channelLinkIdstringThe merchant's online store Id
channelOrderDisplayIdstringIdentifier of the order in a human readable format
isCancelledbooleanIndicates if order is canceled.
cancellationReasonstringReason of a cancellation.
customerobjectContains customer details
customer.emailstringCustomer's email
customer.phoneNumberstringCustomer's phone number
customer.namestringCustomer's name (first name + last name).

Headers
string
Defaults to Deliverect/{version}
string
Defaults to {signature}
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json