POS Checkout: eventPosCheckout

The POS Checkout event API captures details related to the point-of-sale (POS) checkout process. It tracks essential transaction details, such as the transaction ID, total price, and product details. This event helps businesses record in-store purchase activities and integrate them into the broader customer data platform.

API Endpoint and Method

URL

https://sandbox.algonomy.com/callback/rest/events/{APP_API_KEY}/eventPosCheckout

Example URL

https://sandbox.algonomy.com/callback/rest/events/ABCDILOBZCGHVLZTCNTGJMYGQEARWVZVCUPYVUGNCZPJRSUDAR/eventPosCheckout

HTTP Method

POST

Parameters

Parameter	Type	Required or Optional	Description
transactionId	String	Optional	Unique identifier for the transaction. Example: "727"
entryNumber			Specifies the entry number. This number can be multiple.
OrderId	String	Optional	Unique identifier for the order. Example: "123"
tenderType	String	Optional	Payment method used, such as cash, card, or net banking. Example: "cash"
checkoutType	String	Optional	Type of checkout, such as guest or logged-in user. Example: "0"
totalPrice	Float	Required	Total price of the transaction. Example: 227.33
shippingCost	Float	Optional	Shipping cost applied to the transaction. Example: "0.0000"
discount	Float	Optional	Discount applied to the transaction. Example: 0
couponCode	String	Optional	Coupon code applied. Example: null
checkoutProducts	String	Optional	Product details involved in the transaction (see sub-parameters below).
billingInfo	Object	Optional	Billing details (see sub-parameters below).
shippingInfo	Object	Optional	Shipping details (see sub-parameters below).

Cart Product Parameters

Parameter	Type	Required or Optional	Description
productId	String	Required	Unique identifier of the product. Example: "814"
productPosition	Integer	Optional	Position of the product in the cart. Example: 1
action	String	Optional	Action performed, such as checkout. Example: "Checkout"
quantity	Integer	Required	Quantity of the product in the cart. Example: 1
productBasePrice	Float	Required	Base price of the product. Example: 210.00
tax	Float	Optional	Tax applied to the product. Example: 17.33
sku	String	Required	SKU of the product. Example: "sku"
discount	Float	Optional	Discount applied to the product. Example: 0.0000
couponCode	String	Optional	Coupon code applied to the product. Example: null

Billing and Shipping Info Parameters

Parameter	Type	Required or Optional	Description
firstName	String	Optional	Specifies the first name of the customer. Example: "John"
lastName	String	Optional	Specifies the last name of the customer. Example: ”Smith”
line1	String	Optional	Specifies the address line 1 of the customer. Example: "4/40"
line2	String	Optional	Specifies the address line 2 of the customer. Example: ”Boulevard Road”
city	String	Optional	Specifies the city. Example: "Chicago"
state	String	Optional	Specifies the state. Example: ”IL”
zip	String	Optional	Specifies the ZIP code. Example:
country	String	Optional	Specifies the country. Example: "IN"
emailAddress	String	Optional	Specifies the email ID of the customer. Example: "john.smith@example.com"
phoneNumber	String	Optional	Specifies the phone number of the customer. Example: "1234567890"

Request Body Schema

{
"eventData":{
"eventType":"eventPosCheckout",
"transactionId":"String",
"tenderType":"String",
"checkoutType":"String",
"totalPrice":"Float",
"shippingCost":"Float"",
"discount":"Float",
"couponCode":"String",
"checkoutProducts":[
{
"productId":"String",
"productPosition":"String",
"action":"String",
"quantity":"Integer",
"productBasePrice":"Float",
"tax":"Float",
"discount":"String",
"couponCode":"String",
"childProductId":"String"
}
],
"billingInfo":{
"firstName":"String",
"lastName":"String",
"line1":"String",
"line2":"String",
"city":"String",
"state":"String",
"zip":"String",
"country":"String",
"emailAddress":"String",
"phoneNumber":"String"
},
"shippingInfo":{
"firstName":"String",
"lastName":"String"",
"line1":"String",
"line2":"String",
"city":"String",
"state":"String",
"zip":"String",
"country":"String",
"emailAddress":"String",
"phoneNumber":"String"
}
}
}

Example Request

{
"eventData":{
"eventType":"eventPosCheckout",
"transactionId":"727",
"tenderType":"cash",
"checkoutType":0,
"totalPrice":227.33,
"shippingCost":"0.0000",
"discount":0,
"couponCode":null,
"checkoutProducts":[
{
"productId":"814",
"productPosition":1,
"action":"Checkout",
"quantity":1,
"productBasePrice":"210.0000",
"tax":"17.3300",
"discount":"0.0000",
"couponCode":null,
"childProductId":"605"
}
],
"billingInfo":{
"firstName":"John",
"lastName":"Smith",
"line1":"4/40",
"line2":"Boulevard Road",
"city":"Chicago",
"state":"IL",
"zip":"60001",
"country":"IN",
"emailAddress":"john.smith@example.com",
"phoneNumber":"1234567890"
},
"shippingInfo":{
"firstName":"John",
"lastName":"Smith",
"line1":"4/40",
"line2":"Boulevard Road",
"city":"Chicago",
"state":"IL",
"zip":"60001",
"country":"IN",
"emailAddress":"john.smith@example.com",
"phoneNumber":"1234567890"
}
}
}

Example Response

{
"status": "success",
"message": "POS checkout event captured successfully."
}

HTTP Response Codes

Response Code	Description
202 Accepted	The request has been received and validated, but processing is asynchronous and not yet complete.