Add Transaction
See the sample example of how a transaction can be added. Links to more detailed instructions can be found at the end of the article.
How this example works
In this example, we will create a sample transaction to trigger the previously created campaign.
Try yourself
Add a transaction Endpoint:
POST /api/{storeCode}/transaction
{ "transaction": { "items": [ { "sku": "12AB", "name": "Restaurant", "quantity": 1, "grossValue": 500, "category": "dine" } ], "header": { "documentType": "sell", "documentNumber": "12345", "purchasePlace": "onsite", "purchasedAt": "2024-05-01T00:00:00", // add current time "labels": [] }, "customerData": { "email": "[email protected]" } } }
This action should trigger
CampaignEffectWasApplied
webhook
Endpoints used
This method allows creating a new Transaction.
Authorizations
Path parameters
storeCodestringRequired
Store code
Body
Responses
200
Return registered transaction id.
application/json
400
Bad request.
application/json
403
Forbidden.
application/json
post
POST /api/{storeCode}/transaction HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 651
{
"transaction": {
"items": [
{
"sku": "text",
"name": "text",
"quantity": 1,
"grossValue": 1,
"category": "text",
"maker": "text",
"labels": [
{
"key": "text",
"value": "text"
}
]
}
],
"header": {
"documentNumber": "text",
"documentType": "sell",
"linkedDocumentNumber": "text",
"purchasedAt": "2025-07-05T20:02:56.270Z",
"purchasePlace": "text",
"labels": [
{
"key": "text",
"value": "text"
}
]
},
"customerData": {
"customerId": "text",
"name": "text",
"email": "text",
"phone": "text",
"loyaltyCardNumber": "text",
"nip": "text",
"address": {
"street": "text",
"address1": "text",
"address2": "text",
"postal": "text",
"city": "text",
"province": "text",
"country": "text"
}
},
"channelId": "123e4567-e89b-12d3-a456-426614174000"
}
}
{
"transactionId": "00000000-0000-0000-0000-000000000000"
}
More resources
For a detailed overview and description of the creation and management of the transaction, please refer to these series of articles:
TransactionsIn this section, you will learn everything about Transactions. We will show you how to create Transactions, match them with customers, and many more important and helpful features.Last updated
Was this helpful?