Skip to main content

TransactionsService

A list of all methods in the TransactionsService service. Click on the method name to view detailed information about that method.

MethodsDescription
ImportTransactionsImportReceiptsAsyncThe /receipts endpoint is used to store each customers purchase and returns in Engage. All fields in the data model can be used for segmentation and analysis in Engage. If you want to send out transactional emails, use the /orders endpoint instead. ### Identification To be able to store a receipt in Voyado, you need to connect it to a specific contact. In the example payload below the contact type is “Member” and the key type is “email” The key has to be a unique data field for the specific contact type, normally one of these fields: - contactId - email - mobilePhone - memberNumber - externalId - socialSecurityNumber (personal identity number - only Swedish or Finnish)
ImportTransactionsImportAsyncRequired on receipt: externalId (Unique receipt id), invoiceNumber, customerKey, customerKeyType, invoiceCreatedDate, InvoiceModifiedDate, StoreName, StoreNumber Required on transaction: externalId (Unique transaction id), articleNr, quantity, price and type (RETURN/DISCOUNT/PURCHASE) Note! It's recommended to include Sku, as it's a required attribute when enriching purchase data from article data.

ImportTransactionsImportReceiptsAsync

The /receipts endpoint is used to store each customers purchase and returns in Engage. All fields in the data model can be used for segmentation and analysis in Engage. If you want to send out transactional emails, use the /orders endpoint instead. ### Identification To be able to store a receipt in Voyado, you need to connect it to a specific contact. In the example payload below the contact type is “Member” and the key type is “email” The key has to be a unique data field for the specific contact type, normally one of these fields: - contactId - email - mobilePhone - memberNumber - externalId - socialSecurityNumber (personal identity number - only Swedish or Finnish)

  • HTTP Method: POST
  • Endpoint: /api/v2/receipts

Parameters

NameTypeRequiredDescription
inputReceiptThe request body.

Return Type

object

Example Usage Code Snippet

using VoyadoEngage;
using VoyadoEngage.Models;

var client = new VoyadoEngageClient();

var contact = new ReceiptContact("matchKey", ReceiptContact.ReceiptContactMatchKeyType.Email);
var paymentMethodsItem = new ReceiptPaymentMethod("type", 5.08);
var paymentMethods = new List<ReceiptPaymentMethod>() { paymentMethodsItem };
var itemsItem = new ReceiptItem(ReceiptItem.ReceiptItemType.Purchase, "sku", 1, 1.17, 4.39, 1.12, "articleNumber", "articleName");
var items = new List<ReceiptItem>() { itemsItem };
var input = new Receipt(contact, "uniqueReceiptId", "receiptNumber", "createdDate", "storeExternalId", "currency", 7.19, paymentMethods, items);

var response = await client.Transactions.ImportTransactionsImportReceiptsAsync(input);

Console.WriteLine(response);

ImportTransactionsImportAsync

Required on receipt: externalId (Unique receipt id), invoiceNumber, customerKey, customerKeyType, invoiceCreatedDate, InvoiceModifiedDate, StoreName, StoreNumber Required on transaction: externalId (Unique transaction id), articleNr, quantity, price and type (RETURN/DISCOUNT/PURCHASE) Note! It's recommended to include Sku, as it's a required attribute when enriching purchase data from article data.

  • HTTP Method: POST
  • Endpoint: /api/v2/transactions

Parameters

NameTypeRequiredDescription
inputImportTransactionsObjectThe request body.

Return Type

object

Example Usage Code Snippet

using VoyadoEngage;
using VoyadoEngage.Models;

var client = new VoyadoEngageClient();

var input = new ImportTransactionsObject();

var response = await client.Transactions.ImportTransactionsImportAsync(input);

Console.WriteLine(response);

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →