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.

This method allows creating a new Transaction.

POSThttp://openloyalty.localhost/api/{storeCode}/transaction

Path parameters

storeCode*string

Store code

Body

application/json

transactionPostTransaction (object)

Response

200400403

Return registered transaction id.

Body

application/json

transactionIdstring

Registered transaction identity

Example: "00000000-0000-0000-0000-000000000000"

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/{storeCode}/transaction', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403

{
  "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:

TransactionsUser Guide