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

• Input the previous saved token and storeCode in the request header

• 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": "[e-mail]"
          }
      }
  }

• This action should trigger CampaignEffectWasApplied webhook

---

Endpoints used

Method allows to register new transaction in system.

post

This method allows creating a new Transaction.

Authorizations

Path parameters

storeCodestringrequired

Store code

Body

transactionobjectoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://openloyalty.localhost/api/{storeCode}/transaction' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-03-27T16:49:11.653Z",
        "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"
    }
  }'

200

400

403

200

{
  "transactionId": "00000000-0000-0000-0000-000000000000"
}

Return registered transaction id.

---

More resources

For a detailed overview and description of the creation and management of the transaction, please refer to these series of articles:

TransactionsUser Guide