Payload examples
Here are some payload examples sent from the Shopify POS app to Engage.
Customer
{
"city": "Hull",
"contactType": "member",
"country": "United Kingdom",
"countryCode": "GB",
"email": "john.doe@voyado.com",
"externalId": 6725073076536,
"language":"en",
"firstName": "John",
"lastName": "Doe",
"mobilePhone": "+46 16 779 3703",
"preferences": {
"acceptsEmail": true,
"acceptsPostal": false,
"acceptsSms": false
},
"street": "Streetlife Museum",
"zipCode": "HU1 1PS"
}Purchase
{
"contact": {
"contactType": "member",
"matchKey": "aa34ebae-ffcf-4d73-99e4-af720106c055",
"matchKeyType": "contactId"
},
"createdDate": "2022-12-21T15:56:30+00:00",
"currency": "GBP",
"exchangeRateToGroupCurrency": 0.877969,
"items": [
{
"articleName": "Example Pants",
"articleNumber": "13435",
"discounts": [],
"grossPaidPrice": 49.99,
"quantity": 1,
"sku": "13435",
"taxAmount": 8.33,
"taxPercent": 20,
"type": "PURCHASE"
}
],
"paymentMethods": [
{
"description": "bogus",
"type": "bogus",
"value": 49.989999999999995
}
],
"receiptNumber": 1064,
"storeExternalId": "pos-uk",
"taxDetails": [
{
"description": "GB VAT",
"value": 7.99
},
{
"description": "GB VAT",
"value": 0
}
],
"totalGrossPrice": 49.989999999999995,
"uniqueReceiptId": 5221505696056,
"usedBonusChecks": [],
"usedPromotions": []
}Return
{
"contact": {
"contactType": "member",
"matchKey": "aa34ebae-ffcf-4d73-99e4-af720106c055",
"matchKeyType": "contactId"
},
"createdDate": "2022-12-22T10:10:48+00:00",
"currency": "GBP",
"exchangeRateToGroupCurrency": 0.877969,
"items": [
{
"articleName": "Example Pants",
"articleNumber": "13435",
"grossPaidPrice": 49.989999999999995,
"quantity": -1,
"sku": "13435",
"taxAmount": 8.331666666666667,
"taxPercent": 20,
"type": "RETURN"
}
],
"paymentMethods": [
{
"description": "bogus",
"type": "bogus",
"value": -49.989999999999995
}
],
"receiptNumber": 1064,
"storeExternalId": "pos-uk",
"taxDetails": [
{
"description": "Tax Refund",
"value": 8.33
}
],
"totalGrossPrice": -49.989999999999995,
"uniqueReceiptId": 940100682040
}Order confirmation
{
"contact": {
"matchKey": "accelerators@voyado.com",
"matchKeyType": "email"
},
"orderStatus": "CONFIRMED_POS",
"paymentStatus": "PAID",
"orderNumber": "#1052",
"createdDate": "2023-09-22T12:35:39+00:00",
"shippingDate": "2023-09-22T12:35:40Z",
"statusChangedDate": "2023-09-22T12:35:41+00:00",
"storeId": "pos-uk",
"currency": "GBP",
"language": "en",
"totalGrossPrice": 2074.95,
"totalTax": "0.0",
"freightFee": {
"value": "0",
"tax": 0
},
"taxDetails": [],
"extraData": {
"CreatedDate": "2023-09-22T12:35:39+00:00",
"ShippingDate": "2023-09-22T12:35:40Z",
"ShippingAddressEmail": "accelerators@voyado.com",
"PaymentMethod": "cash",
"BillingAddressEmail": "accelerators@voyado.com"
},
"items": [
{
"type": "PURCHASE",
"quantity": 1,
"grossPaidPrice": 24.95,
"taxAmount": 0,
"taxPercent": 0,
"sku": "n/a",
"description": "Selling Plans Ski Wax - Selling Plans Ski Wax",
"imageUrl": "https://cdn.shopify.com/s/files/1/0811/4015/4690/products/snowboard_wax.png?v=1691742154",
"targetUrl": "https://voyado-pos-test.myshopify.com/products/selling-plans-ski-wax",
"articleName": "Selling Plans Ski Wax",
"articleNumber": "n/a",
"discounts": []
},
{
"type": "PURCHASE",
"quantity": 2,
"grossPaidPrice": 2050,
"taxAmount": 0,
"taxPercent": 0,
"sku": "sku-hosted-5",
"description": "The Collection Snowboard: Oxygen",
"imageUrl": "https://cdn.shopify.com/s/files/1/0811/4015/4690/products/Main_d624f226-0a89-4fe1-b333-0d1548b43c06.jpg?v=1691742152",
"targetUrl": "https://voyado-pos-test.myshopify.com/products/the-collection-snowboard-oxygen",
"articleName": "The Collection Snowboard: Oxygen",
"articleNumber": "sku-hosted-5",
"discounts": []
}
]
}Order fulfilled
{
"contact": {
"matchKey": "accelerators@voyado.com",
"matchKeyType": "email"
},
"orderStatus": "FULFILLED_POS",
"paymentStatus": "PAID",
"orderNumber": "#1052",
"createdDate": "2023-09-22T12:35:39+00:00",
"shippingDate": "2023-09-22T12:35:40Z",
"statusChangedDate": "2023-09-22T12:35:41+00:00",
"storeId": "pos-uk",
"currency": "GBP",
"language": "en",
"totalGrossPrice": 2074.95,
"totalTax": "0.0",
"freightFee": {
"value": "0",
"tax": 0
},
"taxDetails": [],
"extraData": {
"CreatedDate": "2023-09-22T12:35:39+00:00",
"ShippingDate": "2023-09-22T12:35:40Z",
"ShippingAddressEmail": "accelerators@voyado.com",
"PaymentMethod": "cash",
"BillingAddressEmail": "accelerators@voyado.com"
},
"items": [
{
"type": "PURCHASE",
"quantity": 1,
"grossPaidPrice": 24.95,
"taxAmount": 0,
"taxPercent": 0,
"sku": "n/a",
"description": "Selling Plans Ski Wax - Selling Plans Ski Wax",
"imageUrl": "https://cdn.shopify.com/s/files/1/0811/4015/4690/products/snowboard_wax.png?v=1691742154",
"targetUrl": "https://voyado-pos-test.myshopify.com/products/selling-plans-ski-wax",
"articleName": "Selling Plans Ski Wax",
"articleNumber": "n/a",
"discounts": []
},
{
"type": "PURCHASE",
"quantity": 2,
"grossPaidPrice": 2050,
"taxAmount": 0,
"taxPercent": 0,
"sku": "sku-hosted-5",
"description": "The Collection Snowboard: Oxygen",
"imageUrl": "https://cdn.shopify.com/s/files/1/0811/4015/4690/products/Main_d624f226-0a89-4fe1-b333-0d1548b43c06.jpg?v=1691742152",
"targetUrl": "https://voyado-pos-test.myshopify.com/products/the-collection-snowboard-oxygen",
"articleName": "The Collection Snowboard: Oxygen",
"articleNumber": "sku-hosted-5",
"discounts": []
}
]
}Order refunded
{
"contact": {
"matchKey": "accelerators@voyado.com",
"matchKeyType": "email"
},
"createdDate": "2023-09-22T12:37:50+00:00",
"storeId": "123",
"orderNumber": "#1052",
"currency": "GBP",
"language": "en",
"totalGrossPrice": -2074.95,
"totalTax": 0,
"orderStatus": "REFUNDED_POS",
"paymentStatus": "PAID",
"extraData": {
"CreatedDate": "2023-09-22T12:37:50+00:00",
"ReturnDate": "2023-09-22T12:37:50+00:00",
"BillingAddressEmail": "accelerators@voyado.com"
},
"items": [
{
"type": "RETURN",
"quantity": -1,
"grossPaidPrice": 1037.475,
"taxAmount": 0,
"taxPercent": 0,
"sku": "n/a",
"articleName": "Selling Plans Ski Wax",
"articleNumber": "n/a",
"description": "Selling Plans Ski Wax",
"imageUrl": "https://cdn.shopify.com/s/files/1/0811/4015/4690/products/snowboard_wax.png?v=1691742154",
"targetUrl": "https://voyado-pos-test.myshopify.com/products/selling-plans-ski-wax"
},
{
"type": "RETURN",
"quantity": -2,
"grossPaidPrice": 1037.475,
"taxAmount": 0,
"taxPercent": 0,
"sku": "sku-hosted-5",
"articleName": "The Collection Snowboard: Oxygen",
"articleNumber": "sku-hosted-5",
"description": "The Collection Snowboard: Oxygen",
"imageUrl": "https://cdn.shopify.com/s/files/1/0811/4015/4690/products/Main_d624f226-0a89-4fe1-b333-0d1548b43c06.jpg?v=1691742152",
"targetUrl": "https://voyado-pos-test.myshopify.com/products/the-collection-snowboard-oxygen"
}
]
}