Skip to main content

Sample Code

Identify Customers

Sample Request Body

{
"outHTTP":{
"body":{
"action_type":"identifyCustomers",
"acquired_method":"SCAN",
"application_version":"3.8.25",
"clerk_id":"999999",
"date_time":"2023-12-04T09:37:04.430Z",
"local_date":"999999",
"local_time":"999999",
"terminal_id":"999999999999",
"terminal_txn_id":"999999",
"receipt_datetime":"20YY-12-04T09:37:04.430Z",
"check_id":"999999999999",
"transaction_token":"9999999999",
"integrator_name":"xpos",
"integrator_type":"pos",
"configuration":{
"location":{
"address_1":"xxxxx",
"address_2":"",
"city":"Xxxx",
"country":"XX"
}
},
"customer_id":"9999999999"
},
"headers":{
"Accept":"application/json",
"Connection":"keep-alive",
"Content-Type":"application/json",
"x-company-id":"xxxxxxxxxxxxxxxxxxxxxxx",
"x-site-ids":"xxxxxxxxxxxxxxxxxxxxxxx"
},
"host":"xxxxx.xxx.xxx",
"method":"POST",
"path":"/api/xgl"
}
}

Sample Response Body

{
"server_date_time":"20YY-01-11T16:31:20.409Z",
"host_txn_id":"999999999999", 
"merchant_data":{
"name":"Provider Name",
"id":"Provider Id",
"response_code":200,
"response_message":"Authorized",
"response_name":"authorizedSuccess",
"authorization_code":"999999"
},
"customers":[ 
{
"is_identified":true,
"information":{
"first_name":"First",
"last_name":"Last",
"loyalty_card_number":"9999999999",
"id":"1234",
"email":"xxxxxx.xxxxxx@xxxxx.xxx",
"phone":"9999999999",
"address":{
"address_1":"address",
"city":"city",
"state":"state",
"zip_code":"999"
},
"preferred_tips":[
customer
{
"order_amount":10,
"calc_method":"fixed_amount",
"value":0.75
},
{
"calc_method":"percent",
"value":10
}
]
},
"balance":[ 
{
"name":"Points",
"balance":185,
"expiration_dates":[]
}
],
"rewards":[ 
loyalty account
{
"id":"99",
"expiration_dates":[],
"name":"Free Product",
"balance":1,
"program_id":"1",
"apply_automatically":false,
"calculated_by":"provider",
"reward_type":"discount",
"associated_points":100,
"promoted":true,
"promotion_type":"Welcome Reward",
"qualified":false
},
{
"id":"999",
"expiration_dates":[],
"name":"10% off",
"balance":1,
"apply_automatically":false,
"calculated_by":"provider",
"reward_type":"discount",
"qualified":false
}
],
"promotions":[],
"cards":[ 
{
"card_number":"999999999999",
"card_balance":"3.26"
}
],
"rewards_data":{
"validated_rewards":[],
"declined_rewards":[]
},
"identification_method":"code" 
}
]
}

Simulate Accrual

Sample Request Body

{
"outHTTP":{
"body":{
"action_type":"simulateAccrual",
"application_version":"3.2.16",
"clerk_id":"999999",
"date_time":"20YY-12-04T09:37:04.430Z",
"local_date":"999999",
"local_time":"999999",
"terminal_id":"999999999999",
"terminal_txn_id":"999999",
"receipt_datetime":"2023-12-04T09:37:04.430Z",
"check_id":"999999999999",
"transaction_token":"9999999999",
"integrator_name":"xpos",
"integrator_type":"pos",
"configuration":{
"location":{
"address_1":"xxxxx",
"address_2":"",
"city":"Xxxx",
"country":"XX"
}
},
"order":{
"_id":"01ab111c-0d1d-1234-5678-i11de234bc15",
"business_date":"2023-12-04T00:00:00.000Z",
"company_id":"999999999999",
"contributors":[
{
"employee":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"terminal":{
"_id":"1e11adcd0f111271613b1f31",
"terminal_number":"1",
"title":"Terminal 1"
},
"time":"2023-12-04T09:37:04.430Z"
}
],
"creator":{
"employee":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"terminal":{
"_id":"1e11adcd0f111271613b1f31",
"terminal_number":"11",
"title":"Terminal 1"
},
"time":"2023-12-04T09:37:04.430Z"
},
"customer":{
"loyalty_info":{
"balances":[
{
"name":"Points",
"balance":185,
"expiration_dates":[
]
}
],
"cards":[
{
"card_number":"999999999999",
"card_balance":"3.26"
}
],
"customer":{
"address":"{}",
"code":"9999",
"email":"xxxxxx.xxxxxx@xxxxx.xxx",
"first_name":"Xxxxx",
"id":"99999999",
"identification_method":"phone_number",
"last_name":"X",
"phone":"9999999999",
"preferred_tips":[
{
"calc_method":"fixed_amount"
}
]
},
"identify_customer":{
"transaction_id":"0000"
},
"offers":[
{
"apply_automatically":false,
"calculated_by":"provider",
"expiration_date":"2023-12-28T09:59:59Z",
"id":"99",
"name":"Free Product",
"points_required":null,
"promoted":true,
"promotion_type":"Welcome Reward",
"qualified":true,
"reward_type":"reward",
"status":"validated"
}
],
"preferred_tips":[
{
"calc_method":"fixed_amount"
}
]
}
},
"day_part_info":{
"day_part_type_id":"11f81f84e11111cd1c1bcc1a",
"day_part_type_name":"Evening",
"external_id":null
},
"destination":{
"_id":"1fff1ca1c1ae01101fe116a1",
"allow_park_car":false,
"background_color":"#7c8700",
"consumption_type":"OffPremises",
"default_taxable_destination":false,
"entity_id":"11f0cde66e011d000121181e",
"external_id":"drive thru",
"guest_count_calculation_method":"by_segment",
"id":"drive thru",
"is_explicitly_selected":true,
"name":"Drive Thru",
"optional_customer_info":[
"vehicle_type"
],
"required_customer_info":[
],
"segment_name":"tray",
"short_name":"DT",
"text_color":"#fff",
"time_based_customer_fields":[
]
},
"discount_info":{
"discounts":[
{
"order_discount_id":"999999999999",
"discount_definition_id":"999999999999",
"discount_code":"11",
"name":"Guest Checked In",
"apply_type":"manual",
"apply_post_tax":false,
"created_at":"20YY-12-04T09:37:03.929Z",
"updated_at":"20YY-12-04T09:37:03.929Z",
"use_loyalty":false,
"discount_type":"discount",
"discount_variable_value":0.01,
"quantity":1,
"amount":0.01,
"amount_unrounded":0.01,
"distributed":false
}
],
"total":0.01,
"total_unrounded":0.01,
"discount_map":[
]
},
"discount_total":0.01,
"expo_number":"999999",
"fulfillment_status":"submitted",
"guest_count":1,
"hash_code":
"12a34fecd567897a2a1ab1234b12345678d1f12b12d2cbabbd340d031b1aa101",
"items":[
{
"entity_id":"1c11e1234f011a0012342118",
"guest_count":0,
"item_type":"standard",
"name":"Medium Coffee",
"alternate_kitchen_name":"",
"revenue_class":[
],
"reporting_category":{
},
"product_id":"101",
"kitchen_routing_categories":[
],
"tax_group":{
},
"tax_inclusive":true,
"price":4.75,
"unit_price":4.75,
"tags":[
],
"item_count_quantity":1,
"product_ingredients":[
],
"quantity":1,
"segment_id":"012a1eda-1b1-1e2f-bd3d-500f2f11d111",
"order_item_id":"111fab1-1213-19a3-568f-e1234056789a",
"time":{
},
"state":"pending",
"payment_status":"open",
"child_items":[
],
"tax_inclusive_price":4.75,
"discount_info":{
"discounts":[
{
"order_discount_id":"999999999999",
"discount_definition_id":"999999999999",
"discount_code":"123",
"name":"Free Drink",
"apply_type":"manual",
"apply_post_tax":false,
"created_at":"20YY-12-04T09:37:03.929Z",
"updated_at":"20YY-12-04T09:37:03.929Z",
"use_loyalty":false,
"discount_type":"discount",
"discount_variable_value":4.75,
"quantity":1,
"amount":4.75,
"amount_unrounded":4.75,
"distributed":true
}
],
"total":4.75,
"total_unrounded":4.75
},
"tags_info":[
{
"entity_id":"999999999999",
"name":"All Drinks Discounts",
"tag_id":"111"
}
]
}
],
"lifecycle":"pending",
"notification_status":"open",
"order_number":"999999",
"order_source":"POS",
"order_source_ext":{
"is_marketplace":false,
"is_tax_liable":false,
"name":"POS",
"order_source_id":"111"
},
"order_status":{
"status":"pending"
},
"order_type":"order",
"origin":"777",
"owner":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"payment_info":{
},
"payment_status":"open",
"segments":[
],
"sequential_order_number":"99",
"site_info":{
"address":"9999 Xxxx Xxxx",
"address2":"",
"apps":[
{
"app_code":"XPOS",
"preferred_version":{
"uri":"https://pos-download.xenial.com/pos-app/3.8.1/",
"version":"3.8.1"
}
}
],
"city":"Xxxxxxx",
"company":{
"id":"99a9e0da999aa90ab9c9d2e7e",
"name":"Company Name"
},
"email":"",
"id":"11a1e0da111aa10ab1c1d2e1e",
"isOnlineOrderingAvailable":true,
"name":"Site Name",
"phone":"",
"state":"XX",
"store_number":"1234",
"timezone":"US/Pacific",
"website":"",
"zip":"99999"
},
"state":"xxxxxxx",
"subtotal":4.75,
"tax_inclusive_subtotal":4.75,
"tax_info":{
"taxes":[
{
"amount":0.0,
"amount_unrounded":0.0,
"marketplace_liable":false,
"name":"Sales Tax",
"tax_class":"sales_tax",
"tax_definition_id":"123456d0a0b1f11d111d511e",
"tax_inclusive":true
}
],
"total_marketplace_liable_unrounded":0,
"total_marketplace_liable":0,
"total_inclusive_unrounded":0,
"total_inclusive":0,
"total_exclusive_unrounded":0,
"total_exclusive":0,
"total_unrounded":0,
"total":0
},
"time":{
},
"total":0.0,
"version":"111"
}
},
"headers":{
"Accept":"application/json",
"Connection":"keep-alive",
"Content-Type":"application/json",
"x-company-id":"xxxxxxxxxxxxxxxxxxxxxxx",
"x-site-ids":"xxxxxxxxxxxxxxxxxxxxxxx"
},
"host":"xxxxx.xxx.xxx",
"method":"POST",
"path":"/api/xgl"
}
}

Sample Response Code

{
  "server_date_time": "2023-12-04T09:37:04.211Z",
  "host_txn_id": "999999999999",
  "merchant_data": {
    "name": "Provider Name",
    "id": "999999",
    "response_name": "success"
  },
  "rewards_data": {
    "validated_rewards": [
      {
        "name": "Free Product",
        "reward_id": "12",
        "quantity_redeemed": "1",
        "apply_automatically": false,
        "program_id": "1",
        "offer_id": "99",
        "amount": "4.75",
        "rewarded_items": [
          {
            "name": "Medium Coffee",
            "amount": 4.75,
            "quantity": "1",
            "id": "101",
            "item_id": "111fab1-1213-19a3-568f-e1234056789a"
          }
        ]
      }
    ],
    "declined_rewards": []
  }
}

Redeem Reward

Sample Request Body

{
"outHTTP":{
"body":{
"action_type":"redeemReward",
"application_version":"3.2.16",
"clerk_id":"999999",
"date_time":"20YY-12-04T09:37:04.430Z",
"local_date":"999999",
"local_time":"999999",
"terminal_id":"999999999999",
"terminal_txn_id":"999999",
"receipt_datetime":"20YY-12-04T09:37:04.430Z",
"check_id":"999999999999",
"transaction_token":"9999999999",
"integrator_name":"xpos",
"integrator_type":"pos",
"is_retry":false,
"configuration":{
"location":{
"address_1":"xxxxx",
"address_2":"",
"city":"Xxxx",
"country":"XX"
}
},
"order":{
"_id":"01ab111c-0d1d-1234-5678-i11de234bc15",
"business_date":"20YY-12-04T00:00:00.000Z",
"company_id":"999999999999",
"contributors":[
{
"employee":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"terminal":{
"_id":"1e11adcd0f111271613b1f31",
"terminal_number":"1",
"title":"Terminal 1"
},
"time":"2023-12-04T09:37:04.430Z"
}
],
"creator":{
"employee":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"terminal":{
"_id":"1e11adcd0f111271613b1f31",
"terminal_number":"11",
"title":"Terminal 1"
},
"time":"2023-12-04T09:37:04.430Z"
},
"customer":{
"loyalty_info":{
"balances":[
],
"cards":[
],
"customer":{
"address":"{}",
"code":"9999",
"email":"xxxxxx.xxxxxx@xxxxx.xxx",
"first_name":"Xxxxx",
"id":"99999999",
"identification_method":"phone_number",
"last_name":"X",
"phone":"9999999999",
"preferred_tips":[
{
"calc_method":"fixed_amount"
}
]
},
"identify_customer":{
"transaction_id":"0000"
},
"is_primary":true,
"offers":[
{
"apply_automatically":false,
"calculated_by":"provider",
"expiration_date":"2023-12-28T09:59:59Z",
"id":"99",
"name":"Free Product",
"points_required":null,
"promoted":true,
"promotion_type":"Welcome Reward",
"qualified":true,
"reward_type":"reward",
"status":"validated"
},
{
"apply_automatically":false,
"calculated_by":"provider",
"expiration_date":"2023-12-28T09:59:59Z",
"id":"999",
"name":"10% off",
"points_required":null,
"promoted":false,
"qualified":true,
"reward_type":"reward",
"status":"validated"
}
],
"preferred_tips":[
{
"calc_method":"fixed_amount"
}
]
}
},
"day_part_info":{
"day_part_type_id":"11f81f84e11111cd1c1bcc1a",
"day_part_type_name":"Evening",
"external_id":null
},
"destination":{
"_id":"1fff1ca1c1ae01101fe116a1",
"allow_park_car":false,
"background_color":"#7c8700",
"consumption_type":"OffPremises",
"default_taxable_destination":false,
"entity_id":"11f0cde66e011d000121181e",
"external_id":"drive thru",
"guest_count_calculation_method":"by_segment",
"id":"drive thru",
"is_explicitly_selected":true,
"name":"Drive Thru",
"optional_customer_info":[
"vehicle_type"
],
"required_customer_info":[
],
"segment_name":"tray",
"short_name":"DT",
"text_color":"#fff",
"time_based_customer_fields":[
]
},
"discount_info":{
"discounts":[
{
"order_discount_id":"999999999999",
"discount_definition_id":"999999999999",
"discount_code":"defaultLoyaltyOrderLevelDiscount",
"name":"10% off",
"apply_type":"manual",
"apply_post_tax":false,
"created_at":"20YY-12-04T09:37:03.929Z",
"updated_at":"20YY-12-04T09:37:03.929Z",
"use_loyalty":false,
"discount_type":"discount",
"discount_variable_value":1.25,
"loyalty_info":{
"amount":1.25,
"apply_automatically":false,
"calculated_by":"provider",
"name":"10% off",
"offer_id":"999",
"program_id":"1",
"quantity_redeemed":"1",
"reward_id":"123",
"status":"validated"
},
"quantity":1,
"amount":1.25,
"amount_unrounded":1.25,
"distributed":false
}
],
"total":1.25,
"total_unrounded":1.25,
"discount_map":[
]
},
"discount_total":6.0,
"expo_number":"999999",
"fulfillment_status":"submitted",
"guest_count":1,
"hash_code":
"12a34fecd567897a2a1ab1234b12345678d1f12b12d2cbabbd340d031b1aa101",
"items":[
{
"entity_id":"1c11e1234f011a0012342118",
"guest_count":0,
"item_type":"standard",
"name":"Medium Coffee",
"alternate_kitchen_name":"",
"revenue_class":[
],
"reporting_category":{
},
"product_id":"101",
"kitchen_routing_categories":[
],
"tax_group":{
},
"tax_inclusive":true,
"price":4.75,
"unit_price":4.75,
"tags":[
],
"item_count_quantity":1,
"product_ingredients":[
],
"quantity":1,
"segment_id":"012a1eda-1b1-1e2f-bd3d-500f2f11d111",
"order_item_id":"111fab1-1213-19a3-568f-e1234056789a",
"time":{
},
"state":"pending",
"payment_status":"open",
"child_items":[
],
"tax_inclusive_price":4.75,
"discount_info":{
"discounts":[
{
"order_discount_id":"999999999999",
"discount_definition_id":"999999999999",
"discount_code":"defaultLoyaltyItemLevelDiscount",
"name":"Free Product",
"apply_type":"manual",
"apply_post_tax":false,
"created_at":"20YY-12-04T09:37:03.929Z",
"updated_at":"20YY-12-04T09:37:03.929Z",
"use_loyalty":false,
"discount_type":"discount",
"discount_variable_value":4.75,
"quantity":1,
"amount":4.75,
"amount_unrounded":4.75,
"distributed":false,
"loyalty_info":{
"amount":4.75,
"apply_automatically":false,
"calculated_by":"provider",
"program_id":"1",
"quantity_redeemed":"1",
"reward_id":"12",
"status":"validated"
}
}
],
"total":4.75,
"total_unrounded":4.75
},
"tags_info":[
{
"entity_id":"999999999999",
"name":"All Drinks Discounts",
"tag_id":"111"
}
]
},
{
"entity_id":"2c22e2222f022a0012242218",
"guest_count":0,
"item_type":"standard",
"name":"Large Coffee",
"alternate_kitchen_name":"",
"revenue_class":[
],
"reporting_category":{
},
"product_id":"102",
"kitchen_routing_categories":[
],
"tax_group":{
},
"tax_inclusive":true,
"price":12.5,
"unit_price":12.5,
"tags":[
],
"item_count_quantity":1,
"product_ingredients":[
],
"quantity":1,
"segment_id":"022a2eda-2b2-2e2f-bd2d-200f2f22d222",
"order_item_id":"222fab2-1223-12a3-528f-e1232256789a",
"time":{
},
"state":"pending",
"payment_status":"open",
"child_items":[
],
"tax_inclusive_price":12.5
}
],
"lifecycle":"total",
"notification_status":"open",
"order_number":"999999",
"order_source":"POS",
"order_source_ext":{
"is_marketplace":false,
"is_tax_liable":false,
"name":"POS",
"order_source_id":"111"
},
"order_status":{
"status":"pending"
},
"order_type":"order",
"origin":"777",
"owner":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"payment_info":{
"change":0,
"change_info":[
],
"hash_code":"999999999999999999999999999999999999",
"payments":[
{
"added_at":"99999999999999",
"added_by":"999999e9a9999f000999999d",
"amount":11.25,
"code":"CASH",
"hash_code":"999999999999999999999999999999999999",
"id":"11111111-1c10-10ed-1111-1c11c0010e1a",
"name":"Cash",
"open_cash_drawer":true,
"pay_type_id":"01",
"pay_type_name":"Cash",
"payment_id":"01",
"payment_source":"POS",
"payment_source_ext":{
"name":"POS",
"order_source_id":"111"
},
"processed_at":"2024-03-01T03:59:37.553Z",
"status":"PAID",
"tip_amount":0,
"transaction_type":"SALE"
}
],
"tips":0,
"total":11.25
},
"payment_status":"open",
"segments":[
],
"sequential_order_number":"99",
"site_info":{
"address":"9999 Xxxx Xxxx",
"address2":"",
"apps":[
{
"app_code":"XPOS",
"preferred_version":{
"uri":"https://pos-download.xenial.com/pos-app/3.8.1/",
"version":"3.8.1"
}
}
],
"city":"Xxxxxxx",
"company":{
"id":"99a9e0da999aa90ab9c9d2e7e",
"name":"Company Name"
},
"email":"",
"id":"11a1e0da111aa10ab1c1d2e1e",
"isOnlineOrderingAvailable":true,
"name":"Site Name",
"phone":"",
"state":"XX",
"store_number":"1234",
"timezone":"US/Pacific",
"website":"",
"zip":"99999"
},
"state":"xxxxxxx",
"subtotal":17.25,
"tax_inclusive_subtotal":17.25,
"tax_info":{
"taxes":[
{
"amount":0.0,
"amount_unrounded":0.0,
"marketplace_liable":false,
"name":"Sales Tax",
"tax_class":"sales_tax",
"tax_definition_id":"123456d0a0b1f11d111d511e",
"tax_inclusive":true
}
],
"total_marketplace_liable_unrounded":0,
"total_marketplace_liable":0,
"total_inclusive_unrounded":0,
"total_inclusive":0,
"total_exclusive_unrounded":0,
"total_exclusive":0,
"total_unrounded":0,
"total":0
},
"time":{
},
"total":0.0,
"version":"111"
}
},
"headers":{
"Accept":"application/json",
"Connection":"keep-alive",
"Content-Type":"application/json",
"x-company-id":"xxxxxxxxxxxxxxxxxxxxxxx",
"x-site-ids":"xxxxxxxxxxxxxxxxxxxxxxx"
},
"host":"xxxxx.xxx.xxx",
"method":"POST",
"path":"/api/xgl"
}
}

Sample Response Body

{
"host_txn_id":"9999999999",
"merchant_data":{
"id":"Provider Id",
"name":"Provider Name",
"response_name":"success"
},
"rewards_data":{
"declined_rewards":[
],
"redeemed_rewards":[
{
"amount":4.75,
"apply_automatically":false,
"name":"Free Product",
"program_id":"1",
"quantity_redeemed":"1",
"redemption_code":"123",
"reward_id":"12",
"rewarded_items":[
{
"name":"Medium Coffee",
"amount":4.75,
"quantity":"1",
"id":"101",
"item_id":"111fab1-1213-19a3-568f-e1234056789a"
}
],
"transaction_id":"9999999999"
},
{
"amount":1.25,
"apply_automatically":false,
"name":"10% off",
"quantity_redeemed":"1",
"redemption_code":"124",
"reward_id":"999",
"rewarded_items":[
],
"transaction_id":"99999999999"
}
]
},
"server_date_time":"2024-03-01T03:59:37.954Z"
}

Submit Order

Sample Request Body

{
"outHTTP":{
"body":{
"action_type":"submitOrder",
"application_version":"3.2.16",
"clerk_id":"999999",
"date_time":"2023-12-04T09:47:04.430Z",
"local_date":"999999",
"local_time":"999999",
"terminal_id":"999999999999",
"terminal_txn_id":"999999",
"receipt_datetime":"2023-12-04T09:37:04.430Z",
"check_id":"999999999999",
"transaction_token":"9999999999",
"integrator_name":"xpos",
"integrator_type":"pos",
"is_retry":false,
"configuration":{
"location":{
"address_1":"xxxxx",
"address_2":"",
"city":"Xxxx",
"country":"XX"
}
},
"order":{
"_id":"01ab111c-0d1d-1234-5678-i11de234bc15",
"business_date":"2023-12-04T00:00:00.000Z",
"company_id":"999999999999",
"contributors":[
{
"employee":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"terminal":{
"_id":"1e11adcd0f111271613b1f31",
"terminal_number":"1",
"title":"Terminal 1"
},
"time":"2023-12-04T09:37:04.430Z"
}
],
"creator":{
"employee":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"terminal":{
"_id":"1e11adcd0f111271613b1f31",
"terminal_number":"11",
"title":"Terminal 1"
},
"time":"2023-12-04T09:37:04.430Z"
},
"customer":{
"loyalty_info":{
"balances":[
],
"cards":[
],
"customer":{
"address":"{}",
"code":"9999",
"email":"xxxxxx.xxxxxx@xxxxx.xxx",
"first_name":"Xxxxx",
"id":"99999999",
"identification_method":"phone_number",
"last_name":"X",
"phone":"9999999999",
"preferred_tips":[
{
"calc_method":"fixed_amount"
}
]
},
"identify_customer":{
"transaction_id":"0000"
},
"is_primary":true,
"offers":[
{
"apply_automatically":false,
"calculated_by":"provider",
"expiration_date":"2023-12-28T09:59:59Z",
"id":"99",
"name":"Free Product",
"points_required":null,
"promoted":true,
"promotion_type":"Welcome Reward",
"qualified":true,
"reward_type":"reward",
"status":"redeemed"
},
{
"apply_automatically":false,
"calculated_by":"provider",
"expiration_date":"2023-12-28T09:59:59Z",
"id":"999",
"name":"10% off",
"points_required":null,
"promoted":false,
"qualified":true,
"reward_type":"reward",
"status":"redeemed"
}
],
"preferred_tips":[
{
"calc_method":"fixed_amount"
}
]
}
},
"day_part_info":{
"day_part_type_id":"11f81f84e11111cd1c1bcc1a",
"day_part_type_name":"Evening",
"external_id":null
},
"destination":{
"_id":"1fff1ca1c1ae01101fe116a1",
"allow_park_car":false,
"background_color":"#7c8700",
"consumption_type":"OffPremises",
"default_taxable_destination":false,
"entity_id":"11f0cde66e011d000121181e",
"external_id":"drive thru",
"guest_count_calculation_method":"by_segment",
"id":"drive thru",
"is_explicitly_selected":true,
"name":"Drive Thru",
"optional_customer_info":[
"vehicle_type"
],
"required_customer_info":[
],
"segment_name":"tray",
"short_name":"DT",
"text_color":"#fff",
"time_based_customer_fields":[
]
},
"discount_info":{
"discounts":[
{
"order_discount_id":"999999999999",
"discount_definition_id":"999999999999",
"discount_code":"defaultLoyaltyOrderLevelDiscount",
"name":"10% off",
"apply_type":"manual",
"apply_post_tax":false,
"created_at":"20YY-12-04T09:37:03.929Z",
"updated_at":"20YY-12-04T09:37:03.929Z",
"use_loyalty":false,
"discount_type":"discount",
"discount_variable_value":1.25,
"loyalty_info":{
"amount":1.25,
"apply_automatically":false,
"calculated_by":"provider",
"name":"10% off",
"offer_id":"999",
"program_id":"1",
"quantity_redeemed":"1",
"reward_id":"123",
"status":"redeemed"
},
"quantity":1,
"amount":1.25,
"amount_unrounded":1.25,
"distributed":false
}
],
"total":1.25,
"total_unrounded":1.25,
"discount_map":[
]
},
"discount_total":6.0,
"expo_number":"999999",
"fulfillment_status":"submitted",
"guest_count":1,
"hash_code":"12a34fecd567897a2a1ab1234b12345678d1f12b12d2cbabbd340d031b1aa101",
"items":[
{
"entity_id":"1c11e1234f011a0012342118",
"guest_count":0,
"item_type":"standard",
"name":"Medium Coffee",
"alternate_kitchen_name":"",
"revenue_class":[
],
"reporting_category":{
},
"product_id":"101",
"kitchen_routing_categories":[
],
"tax_group":{
},
"tax_inclusive":true,
"price":4.75,
"unit_price":4.75,
"tags":[
],
"item_count_quantity":1,
"product_ingredients":[
],
"quantity":1,
"segment_id":"012a1eda-1b1-1e2f-bd3d-500f2f11d111",
"order_item_id":"111fab1-1213-19a3-568f-e1234056789a",
"time":{
},
"state":"xxxxxxx",
"payment_status":"paid",
"child_items":[
],
"tax_inclusive_price":4.75,
"discount_info":{
"discounts":[
{
"order_discount_id":"999999999999",
"discount_definition_id":"999999999999",
"discount_code":"defaultLoyaltyItemLevelDiscount",
"name":"Free Product",
"apply_type":"manual",
"apply_post_tax":false,
"created_at":"20YY-12-04T09:37:03.929Z",
"updated_at":"20YY-12-04T09:37:03.929Z",
"use_loyalty":false,
"discount_type":"discount",
"discount_variable_value":4.75,
"quantity":1,
"amount":4.75,
"amount_unrounded":4.75,
"distributed":false,
"loyalty_info":{
"amount":4.75,
"apply_automatically":false,
"calculated_by":"provider",
"program_id":"1",
"quantity_redeemed":"1",
"reward_id":"12",
"status":"redeemed"
}
}
],
"total":4.75,
"total_unrounded":4.75
},
"tags_info":[
{
"entity_id":"999999999999",
"name":"All Drinks Discounts",
"tag_id":"111"
}
]
},
{
"entity_id":"2c22e2222f022a0012242218",
"guest_count":0,
"item_type":"standard",
"name":"Large Coffee",
"alternate_kitchen_name":"",
"revenue_class":[
],
"reporting_category":{
},
"product_id":"102",
"kitchen_routing_categories":[
],
"tax_group":{
},
"tax_inclusive":true,
"price":12.5,
"unit_price":12.5,
"tags":[
],
"item_count_quantity":1,
"product_ingredients":[
],
"quantity":1,
"segment_id":"022a2eda-2b2-2e2f-bd2d-200f2f22d222",
"order_item_id":"222fab2-1223-12a3-528f-e1232256789a",
"time":{
},
"state":"xxxxx",
"payment_status":"paid",
"child_items":[
],
"tax_inclusive_price":12.5
}
],
"lifecycle":"total",
"notification_status":"committed",
"order_number":"999999",
"order_source":"POS",
"order_source_ext":{
"is_marketplace":false,
"is_tax_liable":false,
"name":"POS",
"order_source_id":"111"
},
"order_status":{
"status":"closed"
},
"order_type":"order",
"origin":"777",
"owner":{
"code":"99999",
"id":"10e111289b1a34111171b831",
"name":"Employee 1",
"title":"employee"
},
"payment_info":{
"change":0,
"change_info":[
],
"hash_code":"999999999999999999999999999999999999",
"payments":[
{
"added_at":"99999999999999",
"added_by":"999999e9a9999f000999999d",
"amount":11.25,
"code":"CASH",
"hash_code":"999999999999999999999999999999999999",
"id":"11111111-1c10-10ed-1111-1c11c0010e1a",
"name":"Cash",
"open_cash_drawer":true,
"pay_type_id":"01",
"pay_type_name":"Cash",
"payment_id":"01",
"payment_source":"POS",
"payment_source_ext":{
"name":"POS",
"order_source_id":"111"
},
"processed_at":"2024-03-01T03:59:37.553Z",
"status":"PAID",
"tip_amount":0,
"transaction_type":"SALE"
}
],
"tips":0,
"total":11.25
},
"payment_status":"paid",
"segments":[
],
"sequential_order_number":"99",
"site_info":{
"address":"9999 Xxxx Xxxx",
"address2":"",
"apps":[
{
"app_code":"XPOS",
"preferred_version":{
"uri":"https://pos-download.xenial.com/pos-app/3.8.1/",
"version":"3.8.1"
}
}
],
"city":"Xxxxxxx",
"company":{
"id":"99a9e0da999aa90ab9c9d2e7e",
"name":"Company Name"
},
"email":"",
"id":"11a1e0da111aa10ab1c1d2e1e",
"isOnlineOrderingAvailable":true,
"name":"Site Name",
"phone":"",
"state":"XX",
"store_number":"1234",
"timezone":"US/Pacific",
"website":"",
"zip":"99999"
},
"state":"xxxxxxx",
"subtotal":17.25,
"tax_inclusive_subtotal":17.25,
"tax_info":{
"taxes":[
{
"amount":0.0,
"amount_unrounded":0.0,
"marketplace_liable":false,
"name":"Sales Tax",
"tax_class":"sales_tax",
"tax_definition_id":"123456d0a0b1f11d111d511e",
"tax_inclusive":true
}
],
"total_marketplace_liable_unrounded":0,
"total_marketplace_liable":0,
"total_inclusive_unrounded":0,
"total_inclusive":0,
"total_exclusive_unrounded":0,
"total_exclusive":0,
"total_unrounded":0,
"total":0
},
"time":{
},
"total":0.0,
"version":"111"
}
},
"headers":{
"Accept":"application/json",
"Connection":"keep-alive",
"Content-Type":"application/json",
"x-company-id":"xxxxxxxxxxxxxxxxxxxxxxx",
"x-site-ids":"xxxxxxxxxxxxxxxxxxxxxxx"
},
"host":"xxxxx.xxx.xxx",
"method":"POST",
"path":"/api/xgl"
}
}

Sample Response Body

{
"host_txn_id":"9999999",
"merchant_data":{
"id":"Provider Id",
"name":"Provider name",
"response_name":"success"
},
"receipt":{
"balance":[
{
"balance":367,
"expiration_dates":[
]
}
],
"customer_name":"xxx xxxxx",
"loyalty_card_number":"xxxxxxxxx",
"messages":[
],
"rewards":[
]
},
"server_date_time":"2023-12-04T09:47:04.435Z"
}

Void Order

Sample Request Body

{
   "outHTTP": {
      "body": {
         "action_type": "voidOrder",
         "application_version": "3.8.43-4",
         "check_id": "16871931705220000073",
         "clerk_id": "10512684",
         "configuration": {
            "location": {
               "address_1": "7007 SeaWorld Dr",
               "address_2": "",
               "city": "Xxxxxxx",
               "country": "XX",
               "formatted_address": "7007 SeaWorld Dr\nOrlando, Florida  32821, 
United States",
               "geo": {
                  "coordinates": [
                     -81.46193670000001,
                     28.411152
                  ],
                  "type": "Point"
               },
               "geocodingStatus": "OK",
               "state": "XX",
               "zip": "99999"
            },
            "type": "loyalty",
            "use_company_settings": true
         },
         "date_time": "2023-06-19T16:47:15.996Z",
         "integrator_name": "xpos",
         "integrator_type": "pos",
         "is_retry": false,
         "local_date": "20230619",
         "local_time": "044715",
         "order": {
            "__rev__": "2023-06-19T16:46:43.478Z",
            "_id": "7bd53c69-68ba-4449-bf09-4efb5d665339",
            "business_date": "2023-06-19T00:00:00.000Z",
            "company_id": "62ea9f6ed4770e287c3ab373",
            "contributors": [
               {
                  "employee": {
                     "code": "10512684",
                     "id": "6318df61d05afd2443425b6a",
                     "name": "Amanda Beauregard",
                     "title": "employee"
                  },
                  "terminal": {
                     "_id": "5a5901f0fcacfe00019a7fda",
                     "terminal_number": "1",
                     "title": "Terminal 1"
                  },
                  "time": "2023-06-19T16:46:10.522Z"
               },
               {
                  "employee": {
                     "code": "10512684",
                     "id": "6318df61d05afd2443425b6a",
                     "name": "Amanda Beauregard",
                     "title": "employee"
                  },
                  "terminal": {
                     "_id": "5a5901f0fcacfe00019a7fda",
                     "terminal_number": "1",
                     "title": "Terminal 1"
                  },
                  "time": "2023-06-19T16:46:12.230Z"
               },
               {
                  "employee": {
                     "code": "10512684",
                     "id": "6318df61d05afd2443425b6a",
                     "name": "Amanda Beauregard",
                     "title": "employee"
                  },
                  "terminal": {
                     "_id": "5a5901f0fcacfe00019a7fda",
                     "terminal_number": "1",
                     "title": "Terminal 1"
                  },
                  "time": "2023-06-19T16:46:31.444Z"
               }
            ],
            "creator": {
               "employee": {
                  "code": "10512684",
                  "id": "6318df61d05afd2443425b6a",
                  "name": "Amanda Beauregard",
                  "title": "employee"
               },
               "terminal": {
                  "_id": "5a5901f0fcacfe00019a7fda",
                  "terminal_number": "1",
                  "title": "Terminal 1"
               },
               "time": "2023-06-19T16:46:10.522Z"
            },
            "customer": {
               "loyalty_info": {
                  "balances": [],
                  "cards": [],
                  "customer": {
                     "address": "{\"xxxxxxx_9\":\"\",\"xxxxxxx_9\":\"\",
\"xxxxxxx_9\":\"\",\"xxxx\":\"\",\"xxxxx\":\"\",\"xxx_xxxx\":\"\",
\"xxxxxxxxxxxx\":\"\"}",
                     "first_name": "",
                     "identification_method": "code",
                     "last_name": "",
                     "loyalty_card_number": "Q000411495989",
                     "preferred_tips": []
                  },
                  "offers": [
                     {
                        "apply_automatically": true,
                        "calculated_by": "client",
                        "discount_code": "PCT30",
                        "expiration_date": "",
                        "id": "0",
                        "name": "Discount 30%",
                        "program_id": "0"
                     }
                  ],
                  "submit_order": {
                     "processed_at": "2023-06-19T16:46:38.968Z",
                     "transaction_id": "0c9a2fcd-9fb8-44b4-90e0-ae5155ea694b"
                  }
               }
            },
            "day_part_info": {
               "day_part_type_id": "58f86f73be643b665ce91e78",
               "day_part_type_name": "Afternoon",
               "external_id": null
            },
            "destination": {
               "_id": "6463a068e4a173e713968d5e",
               "allow_park_car": false,
               "background_color": "#000093",
               "consumption_type": "OnPremises",
               "default_taxable_destination": false,
               "entity_id": "58f0ce606e034d0001224820",
               "external_id": "dine-in",
               "guest_count_calculation_method": "by_segment",
               "id": "dine-in",
               "name": "Dine In",
               "optional_customer_info": [],
               "required_customer_info": [],
               "segment_name": "tray",
               "short_name": "IN",
               "text_color": "#fff",
               "time_based_customer_fields": []
            },
            "discount_info": {
               "discount_map": [
                  {
                     "discount_definition_id": "646cd880c397a1eadb30bd2f",
                     "loyalty_info": {
                        "amount": 4.2,
                        "apply_automatically": true,
                        "calculated_by": "client",
                        "name": "Discount 30%",
                        "offer_id": "0",
                        "program_id": "0",
                        "quantity_redeemed": "1",
                        "reward_id": "0",
                        "status": "redeemed",
                        "transaction_id": ""
                     },
                     "loyalty_offer_id": "0",
                     "order_discount_id": "61c5ed5d-dcd3-4724-acea-e4fbfffc6420"
                  }
               ],
               "discounts": [
                  {
                     "added_by": "6318df61d05afd2443425b6a",
                     "amount": 4.2,
                     "amount_unrounded": 4.197,
                     "apply_post_tax": false,
                     "apply_type": "manual",
                     "created_at": "2023-06-19T16:46:31.437Z",
                     "discount_code": "PCT30",
                     "discount_definition_id": "646cd880c397a1eadb30bd2f",
                     "discount_type": "discount",
                     "distributed": false,
                     "loyalty_info": {
                        "amount": 4.2,
                        "apply_automatically": true,
                        "calculated_by": "client",
                        "program_id": "0",
                        "quantity_redeemed": "1",
                        "reward_id": "0",
                        "status": "redeemed",
                        "transaction_id": ""
                     },
                     "name": "Discount 30%",
                     "order_discount_id": "61c5ed5d-dcd3-4724-acea-e4fbfffc6420",
                     "quantity": 1,
                     "updated_at": "2023-06-19T16:46:42.846Z",
                     "use_loyalty": false
                  }
               ],
               "total": 4.2,
               "total_unrounded": 4.197
            },
            "discount_total": 4.2,
            "drawer_id": "1ecb1ba8-5b7d-4a8e-b730-5b6abbb3c303",
            "expo_number": "173",
            "fingerprint": "2023-06-19T16:46:43.314Z",
            "fulfillment_status": "pending",
            "guest_count": 1,
            "hash_code": 
"f9ffb19f48bbf7b67a21e8e5e15373b58211871eb51c05a9ba6cdb192919bace",
            "items": [
               {
                  "alternate_kitchen_name": "",
                  "child_items": [],
                  "discount_info": {
                     "discounts": [
                        {
                           "added_by": "6318df61d05afd2443425b6a",
                           "amount": 4.2,
                           "amount_unrounded": 4.197,
                           "apply_post_tax": false,
                           "apply_type": "manual",
                           "created_at": "2023-06-19T16:46:31.437Z",
                           "discount_code": "PCT30",
                           "discount_definition_id": "646cd880c397a1eadb30bd2f",
                           "discount_type": "discount",
                           "distributed": true,
                           "loyalty_info": {
                              "amount": 4.2,
                              "apply_automatically": true,
                              "calculated_by": "client",
                              "program_id": "0",
                              "quantity_redeemed": "1",
                              "reward_id": "0",
                              "status": "redeemed",
                              "transaction_id": ""
                           },
                           "name": "Discount 30%",
                           "order_discount_id": 
"61c5ed5d-dcd3-4724-acea-e4fbfffc6420",
                           "quantity": 1,
                           "updated_at": "2023-06-19T16:46:42.846Z",
                           "use_loyalty": false
                        }
                     ],
                     "total": 0,
                     "total_unrounded": 0
                  },
                  "entity_id": "648883af5ba681df987ac6f7",
                  "external_identifiers": [],
                  "fractional_quantity": {
                     "denominator": 1,
                     "numerator": 1
                  },
                  "fulfillment_status": "pending",
                  "guest_count": 0,
                  "hash_code": 
"4e625801ef892e109d3a329ca51627b9b04fbc6f43dde432a88c2a99e47ac9e2",
                  "is_associated": false,
                  "item_count_quantity": 1,
                  "item_type": "standard",
                  "kitchen_routing_categories": [],
                  "name": "MDAlc12 BnanaPrdse",
                  "order_item_id": "55a2eef2-bbbe-45ed-ad9b-66e874023146",
                  "payment_status": "paid",
                  "price": 13.99,
                  "product_id": "17051110",
                  "product_ingredients": [],
                  "quantity": 1,
                  "reporting_category": {
                     "major_reporting_category": {
                        "_id": "62fd5bb832a7ad00365f46d5",
                        "entity_id": "62fd5bb832a7ad00365f46d4",
                        "external_category_id": "170",
                        "is_major": true,
                        "minor_reporting_category_entity_ids": [
                           "62fd5bb981dd4500358cf85f",
                           "62fd5bb981dd4500358cf860",
                           "62fd5bb981dd4500358cf861",
                           "62fd5bb981dd4500358cf862",
                           "62fd5bb981dd4500358cf863",
                           "62fd5bb981dd4500358cf864",
                           "62fd5bb981dd4500358cf865",
                           "63d29757b4e4a332b2fd94c6",
                           "63d29b49d1c7034a37103996",
                           "63d2a4d4b0e60dd93ac8a85e",
                           "63d2a610b37fc6557aab6010",
                           "63d2be46de98e43f9d00e7e4",
                           "63d2dbe5b37fc6557aabae87",
                           "63fe3cd6e62705ba505aefc9",
                           "6408ca30a75ada2d8085032b",
                           "6422fec19ef90ff556b5f7a1",
                           "6478ef00a0591beb7aa4d72b"
                        ],
                        "name": "Beverages"
                     },
                     "minor_reporting_category": {
                        "_id": "63d2a610b37fc6557aab6014",
                        "entity_id": "63d2a610b37fc6557aab6010",
                        "external_category_id": "1705",
                        "is_major": false,
                        "major_reporting_category_entity_id": 
"62fd5bb832a7ad00365f46d4",
                        "name": "Distilled Liquor"
                     }
                  },
                  "revenue_class": [
                     "default"
                  ],
                  "rollup_after_tax_amount": 0,
                  "rollup_before_tax_amount": 0,
                  "rollup_type": "do_not_roll_up",
                  "segment_id": "9ac5f1d5-d9d7-40d5-a44e-73783c574435",
                  "state": "xxxxxxx",
                  "tags": [],
                  "tax_group": {
                     "_id": "645512ecb819fd00417696a4",
                     "entity_id": "645512d2e4d4bf002e9de750",
                     "name": "Sales Tax",
                     "tax_code": "1"
                  },
                  "tax_inclusive": false,
                  "tax_inclusive_price": 13.99,
                  "tax_info": {
                     "taxes": [
                        {
                           "amount": 0.64,
                           "amount_unrounded": 0.63635,
                           "marketplace_liable": false,
                           "name": "Orlando Sales Tax",
                           "tax_definition_id": "1c8ac24c1fde4a09a150b101",
                           "tax_inclusive": false
                        }
                     ],
                     "total": 0.64,
                     "total_exclusive": 0.64,
                     "total_exclusive_unrounded": 0.63635,
                     "total_inclusive": 0,
                     "total_inclusive_unrounded": 0,
                     "total_marketplace_liable": 0,
                     "total_marketplace_liable_unrounded": 0,
                     "total_unrounded": 0.63635
                  },
                  "taxable_price": 13.99,
                  "time": {
                     "added": "2023-06-19T16:46:10.542Z",
                     "last_modified": "2023-06-19T16:46:42.849Z"
                  },
                  "unit_price": 13.99
               },
               {
                  "child_items": [],
                  "entity_id": "63ff57f840fb762b41e509aa",
                  "fee_config": {
                     "amount": 0.7,
                     "apply_as": "fixed",
                     "apply_pre_tax": true,
                     "fee_type": "surcharge",
                     "precision": 2
                  },
                  "fractional_quantity": {
                     "denominator": 1,
                     "numerator": 1
                  },
                  "hash_code": 
"03364d8609e47bc7e592646955dc1765af94e1f713d8198d0d4131b9352567eb",
                  "item_type": "fee",
                  "name": "Surcharge",
                  "order_item_id": "08fb0f19-3503-4517-ae61-3e81b5bdde9e",
                  "payment_status": "paid",
                  "price": 0.7,
                  "product_id": "997",
                  "quantity": 1,
                  "state": "xxxxxxx",
                  "tax_group": {
                     "_id": "645512ecb819fd00417696a4",
                     "entity_id": "645512d2e4d4bf002e9de750",
                     "name": "Sales Tax",
                     "tax_code": "1"
                  },
                  "tax_inclusive_price": 0.7,
                  "tax_info": {
                     "taxes": [
                        {
                           "amount": 0.04,
                           "amount_unrounded": 0.0455,
                           "marketplace_liable": false,
                           "name": "Orlando Sales Tax",
                           "tax_definition_id": "1c8ac24c1fde4a09a150b101",
                           "tax_inclusive": false
                        }
                     ],
                     "total": 0.04,
                     "total_exclusive": 0.04,
                     "total_exclusive_unrounded": 0.0455,
                     "total_inclusive": 0,
                     "total_inclusive_unrounded": 0,
                     "total_marketplace_liable": 0,
                     "total_marketplace_liable_unrounded": 0,
                     "total_unrounded": 0.0455
                  },
                  "time": {
                     "added": "2023-06-19T16:46:12.239Z",
                     "last_modified": "2023-06-19T16:46:42.849Z"
                  },
                  "unit_price": 0.7
               }
            ],
            "lifecycle": "closed",
            "notification_status": "committed",
            "order_number": "100073",
            "order_source": "In-Store",
            "order_source_ext": {
               "is_marketplace": false,
               "is_tax_liable": false,
               "name": "In-Store",
               "order_source_id": "InStore"
            },
            "order_status": {
               "status": "closed"
            },
            "order_type": "order",
            "origin": "1834-5114",
            "owner": {
               "code": "10512684",
               "id": "6318df61d05afd2443425b6a",
               "name": "Amanda Beauregard",
               "title": "employee"
            },
            "payment_info": {
               "change": 0,
               "change_info": [],
               "hash_code": 
"91fa55ac238e012accf5420af64de5c608d18638cd380ec7b27a0772fc1b7cc2",
               "paid_out_by": "6318df61d05afd2443425b6a",
               "paid_out_by_name": "Amanda Beauregard",
               "payments": [
                  {
                     "added_at": "1687193197762",
                     "added_by": "6318df61d05afd2443425b6a",
                     "amount": 11.17,
                     "code": "CASH",
                     "hash_code": 
"9460a790729b30804a10dec86b37c2e4ebcb65891963ad72702ab679b8bccd71",
                     "id": "7c1238c9-53fb-49c2-b65b-85ac5a83007e",
                     "name": "Cash",
                     "open_cash_drawer": true,
                     "pay_type_id": "01",
                     "pay_type_name": "Cash",
                     "payment_id": "01",
                     "payment_source": "In-Store",
                     "payment_source_ext": {
                        "name": "In-Store",
                        "order_source_id": "InStore"
                     },
                     "processed_at": "2023-06-19T16:46:37.791Z",
                     "provider_name": "xenial_touchless",
                     "status": "PAID",
                     "tip_amount": 0,
                     "transaction_type": "SALE"
                  }
               ],
               "tips": 0,
               "total": 11.17
            },
            "payment_status": "paid",
            "print_info": [
               {
                  "print_type": "customer",
                  "printed_by": "Amanda Beauregard",
                  "time": "2023-06-19T16:46:42.403Z",
                  "user_id": "6318df61d05afd2443425b6a"
               }
            ],
            "segments": [
               {
                  "id": "9ac5f1d5-d9d7-40d5-a44e-73783c574435",
                  "num": 1,
                  "title": "tray"
               }
            ],
            "sequential_order_number": "73",
            "site_info": {
               "address": "9999 XxxXxxxx Xx",
               "address2": "",
               "apps": [
                  {
                     "app_code": "XPOS",
                     "preferred_version": {
                        "uri": 
"https://pos-download.xenial.com/pos-app/3.8.43-4/",
                        "version": "3.8.43-4"
                     }
                  }
               ],
               "city": "Xxxxxxx",
               "company": {
                  "id": "62ea9f6ed4770e287c3ab373",
                  "name": "SeaWorld Parks & Entertainment"
               },
               "email": "",
               "id": "6463a0683d01ab9b50c90d73",
               "isOnlineOrderingAvailable": true,
               "name": "SS Mediterranean Market",
               "phone": "",
               "state": "XX",
               "store_number": "1834-5114",
               "timezone": "EST5EDT",
               "website": "",
               "zip": "99999"
            },
            "state": "xxxxxx",
            "subtotal": 13.99,
            "tax_inclusive_subtotal": 13.99,
            "tax_info": {
               "taxes": [
                  {
                     "amount": 0.68,
                     "amount_unrounded": 0.68185,
                     "marketplace_liable": false,
                     "name": "Orlando Sales Tax",
                     "tax_definition_id": "1c8ac24c1fde4a09a150b101",
                     "tax_inclusive": false
                  }
               ],
               "total": 0.68,
               "total_exclusive": 0.68,
               "total_exclusive_unrounded": 0.68185,
               "total_inclusive": 0,
               "total_inclusive_unrounded": 0,
               "total_marketplace_liable": 0,
               "total_marketplace_liable_unrounded": 0,
               "total_unrounded": 0.68185
            },
            "time": {
               "closed": "2023-06-19T16:46:38.476Z",
               "created": "2023-06-19T16:46:10.522Z",
               "first_item_added": "2023-06-19T16:46:10.527Z",
               "first_saved": "2023-06-19T16:46:15.952Z",
               "last_modified": "2023-06-19T16:46:42.850Z",
               "notification_committed": "2023-06-19T16:46:38.473Z",
               "paid_time": "2023-06-19T16:46:38.473Z"
            },
            "total": 11.17,
            "version": "130"
         },
         "receipt_datetime": "2023-06-19T16:47:15.996Z",
         "terminal_id": "5a5901f0fcacfe00019a7fda",
         "terminal_txn_id": "100073",
         "transaction_token": "3257374927"
      },
      "headers": {
         "Accept": "application/json",
         "Connection": "keep-alive",
         "Content-Type": "application/json",
         "x-company-id": "62ea9f6ed4770e287c3ab373",
         "x-site-ids": "6463a0683d01ab9b50c90d73"
      },
      "host": "gft2x6jqx5.execute-api.us-east-1.amazonaws.com",
      "method": "POST",
      "path": "/prod/loyalty-services/CustomLoyaltyAdapter"
   }
}

Sample Response Body

{
  "currency":"USD",
  "host_txn_id":"164403235",
  "merchant_data":{
    "id":"216",
    "name":"Paytronix",
    "response_name":"success"
  },
  "receipt":{
    "balance":[{
    "balance":56725,
      "expiration_dates":[
        "2022-08-10",
        "2022-08-13",
        "2022-08-17"
      ],
      "name":"Windmill Points",
    }],
    "customer_name":"First_name Last_name",
    "loyalty_card_number":"465938",
    "messages":[],
    "rewards":[{
      "balance":46,
      "expiration_dates":[
        "expiration_date": "12-23-2022",
        "points_quantity" : "123",
      ],
      "id":"8",
      "name":"Dutch Dollars",
      "associated_points": "123",
    }]
  },
  "server_date_time":"2023-06-30T01:33:01.821221Z"
}