Register a transaction

Prev Next
Post
/ecommerce/registerTransaction

Register an ecommerce transaction
Supply the transaction as a required JSON request body containing a transactionItems array. Only userEmail is a query parameter.
Request body example - with custom columns:

{
"transactionItems": [
{
"orderId": "20220204",
"productName": "BOSS bag",
"productSKU": "XXX-123-ABC",
"category": "Exclusive bags",
"brand": "BOSS",
"storeId": "gdg4535fsgdfg",
"purchaseSource": "http://www.mango.com",
"discountValue": "0",
"variant": "BLACK",
"productQuantity": "2",
"discountPercentage": "2",
"imageURL": "http://www.boss.com/bag.jpg",
"productURL": "http://www.boss.com/bag.jpg",
"currency": "PLN",
"timestamp": "2022-02-03T18:25:43",
"productPrice": "45",
"customDetail1": "90",
"customDetail2": "2022-02-03",
"customDetail3": "Sent"
}
]
}


Request body example - 2 items:

{
"transactionItems": [
{
"orderId": "123",
"productName": "BOSS bag",
"productSKU": "XXX-123-ABC",
"category": "Exclusive bags",
"brand": "BOSS",
"storeId": "gdg4535fsgdfg",
"purchaseSource": "http://www.mango.com",
"discountValue": "0",
"variant": "BLACK",
"productQuantity": "1",
"discountPercentage": "2",
"imageURL": "http://www.boss.com/bag.jpg",
"productURL": "http://www.boss.com/bag.jpg",
"currency": "PLN",
"timestamp": "2021-12-15T18:25:43",
"productPrice": "45"
},
{
"orderId": "124",
"productName": "Black Socks",
"productSKU": "XXX-123-UIO",
"category": "Premium Socks",
"brand": "Atlantic",
"storeId": "gdg4535fsgdfg",
"purchaseSource": "http://www.mango.com",
"discountValue": "0",
"variant": "RED",
"productQuantity": "2",
"discountPercentage": "1",
"imageURL": "http://www.atlantic.com/socks.jpg",
"productURL": "http://www.atlantic.com/socks.jpg",
"currency": "PLN",
"timestamp": "2021-12-15T18:25:43",
"productPrice": "12"
}
]
}
Query parameters
userEmail
stringRequired

Email of the user

Body parameters

Transaction as JSON containing a transactionItems array.

Expand All
object
transactionItems
Array of object (TransactionItem)
object
orderId
string
productName
string
productSKU
string
category
string
brand
string
storeId
string
purchaseSource
string
discountValue
string
variant
string
productQuantity
string
discountPercentage
string
returnedQuantity
string
imageURL
string
productURL
string
currency
string
timestamp
string
productPrice
string
customDetail1
string
customDetail2
string
customDetail3
string
customDetail4
string
customDetail5
string
Responses
200
400

Required parameters are missing or incorrect.