Retrieve a transaction
curl --request GET \
--url https://api.vori.com/v1/transactions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vori.com/v1/transactions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vori.com/v1/transactions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vori.com/v1/transactions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vori.com/v1/transactions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vori.com/v1/transactions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/transactions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"cashback_amount": "199.99",
"completed_at": "2023-11-07T05:31:56Z",
"coupon_total": "199.99",
"discount_total": "199.99",
"employee_id": "<string>",
"external_id": "<string>",
"gift_card_sales": [
{
"id": "<string>",
"amount": "199.99",
"gift_card_id": "<string>",
"gift_card_transaction_id": "<string>"
}
],
"gift_card_sales_total": "199.99",
"issued_coupons": [
{
"id": "<string>",
"coupon_code": "<string>",
"coupon_id": "<string>",
"ended_at": "2023-11-07T05:31:56Z",
"offer_benefit_value": "199.99",
"snap_incentive_program_id": "<string>",
"started_at": "2023-11-07T05:31:56Z"
}
],
"item_modifier_total": "199.99",
"lane_id": "<string>",
"line_items": [
{
"id": "<string>",
"coupon_total": "199.99",
"coupons": [
{
"id": "<string>",
"applied_amount": "199.99",
"coupon_code": "<string>",
"coupon_id": "<string>",
"offer_display_text": "<string>",
"offer_id": "<string>"
}
],
"department_id": "<string>",
"discount_total": "199.99",
"discounts": [
{
"id": "<string>",
"applied_amount": "199.99",
"discount_id": "<string>",
"discount_name": "<string>",
"discount_type": "amount_off",
"discount_value": "199.99"
}
],
"ebt_tax_waived_total": "199.99",
"free_quantity": "199.99",
"item_modifier_total": "199.99",
"item_modifiers": [
{
"id": "<string>",
"amount": "199.99",
"item_modifier_id": "<string>",
"quantity": "199.99",
"tax_amount": "199.99",
"taxes": [
{
"id": "<string>",
"amount": "199.99",
"tax_rate": {
"id": "<string>",
"category": "other",
"name": "<string>",
"value": "8.25",
"value_type": "amount"
}
}
]
}
],
"loyalty_rewards": [
{
"id": "<string>",
"applied_amount": "199.99",
"loyalty_reward_id": "<string>",
"loyalty_reward_name": "<string>",
"offer_id": "<string>",
"order_loyalty_reward_id": "<string>"
}
],
"loyalty_rewards_total": "199.99",
"product": {
"id": "<string>",
"barcode": "<string>",
"brand": "<string>",
"ebt_enabled": true,
"name": "<string>",
"sold_by_weight": true,
"unit_of_measure": "<string>",
"unit_of_measure_amount": "199.99",
"wic_enabled": true
},
"promo_savings": "199.99",
"promotions": [
{
"id": "<string>",
"amount": "199.99",
"display_text": "<string>",
"offer_id": "<string>",
"promotion_id": "<string>",
"savings": "199.99"
}
],
"quantity": "199.99",
"refunded_order_line_item_id": "<string>",
"retail_price": "199.99",
"retail_total": "199.99",
"subtotal": "199.99",
"tax_total": "199.99",
"taxable_amount": "199.99",
"taxes": [
{
"id": "<string>",
"amount": "199.99",
"tax_rate": {
"id": "<string>",
"category": "other",
"name": "<string>",
"value": "8.25",
"value_type": "amount"
}
}
],
"total": "199.99",
"transaction_type": "refund",
"type": "refund",
"variable_weights": [
{
"id": "<string>",
"variable_weight": {
"id": "<string>",
"name": "<string>",
"unit": "LBS",
"value": "199.99"
}
}
],
"wic_adjusted_price": "199.99"
}
],
"loyalty_rewards_total": "199.99",
"metadata": {
"order_source": "shopify",
"fulfillment_id": "88213"
},
"payments": [
{
"id": "<string>",
"authorized_amount": "199.99",
"card_brand": "american_express",
"card_last4": "<string>",
"cash_received": "199.99",
"cashback_amount": "199.99",
"change_returned": "199.99",
"completed_at": "2023-11-07T05:31:56Z",
"payment_type": "cash",
"requested_amount": "199.99",
"reversals": [
{
"id": "<string>",
"authorized_amount": "199.99",
"card_brand": "american_express",
"card_last4": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"payment_type": "cash",
"requested_amount": "199.99"
}
],
"terminal_was_online": true,
"till_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tip_amount": "199.99"
}
],
"points_earned": "199.99",
"promo_savings": "199.99",
"promo_total": "199.99",
"receipt_type": "email",
"refund_total": "199.99",
"refunds": [
{
"id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"employee_id": "<string>",
"lane_id": "<string>",
"shopper_facing_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"store_id": "<string>",
"subtotal": "199.99",
"tax_total": "199.99",
"total": "199.99"
}
],
"retail_total": "199.99",
"shopper_facing_id": "<string>",
"shopper_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "api",
"started_at": "2023-11-07T05:31:56Z",
"status": "completed",
"store_id": "<string>",
"subtotal": "199.99",
"tax_total": "199.99",
"taxable_amount": "199.99",
"tip_amount": "199.99",
"total": "199.99",
"total_collected": "199.99",
"type": "refund"
}{
"error_code": "insufficient_permissions",
"error_details": {
"action": "*",
"resource": "*"
}
}Transactions
Retrieve a transaction
Retrieves one transaction with its line items, payments, and a reference to each of its refunds. Related records come back as IDs.
GET
/
v1
/
transactions
/
{id}
Retrieve a transaction
curl --request GET \
--url https://api.vori.com/v1/transactions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vori.com/v1/transactions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vori.com/v1/transactions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vori.com/v1/transactions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vori.com/v1/transactions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vori.com/v1/transactions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/transactions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"cashback_amount": "199.99",
"completed_at": "2023-11-07T05:31:56Z",
"coupon_total": "199.99",
"discount_total": "199.99",
"employee_id": "<string>",
"external_id": "<string>",
"gift_card_sales": [
{
"id": "<string>",
"amount": "199.99",
"gift_card_id": "<string>",
"gift_card_transaction_id": "<string>"
}
],
"gift_card_sales_total": "199.99",
"issued_coupons": [
{
"id": "<string>",
"coupon_code": "<string>",
"coupon_id": "<string>",
"ended_at": "2023-11-07T05:31:56Z",
"offer_benefit_value": "199.99",
"snap_incentive_program_id": "<string>",
"started_at": "2023-11-07T05:31:56Z"
}
],
"item_modifier_total": "199.99",
"lane_id": "<string>",
"line_items": [
{
"id": "<string>",
"coupon_total": "199.99",
"coupons": [
{
"id": "<string>",
"applied_amount": "199.99",
"coupon_code": "<string>",
"coupon_id": "<string>",
"offer_display_text": "<string>",
"offer_id": "<string>"
}
],
"department_id": "<string>",
"discount_total": "199.99",
"discounts": [
{
"id": "<string>",
"applied_amount": "199.99",
"discount_id": "<string>",
"discount_name": "<string>",
"discount_type": "amount_off",
"discount_value": "199.99"
}
],
"ebt_tax_waived_total": "199.99",
"free_quantity": "199.99",
"item_modifier_total": "199.99",
"item_modifiers": [
{
"id": "<string>",
"amount": "199.99",
"item_modifier_id": "<string>",
"quantity": "199.99",
"tax_amount": "199.99",
"taxes": [
{
"id": "<string>",
"amount": "199.99",
"tax_rate": {
"id": "<string>",
"category": "other",
"name": "<string>",
"value": "8.25",
"value_type": "amount"
}
}
]
}
],
"loyalty_rewards": [
{
"id": "<string>",
"applied_amount": "199.99",
"loyalty_reward_id": "<string>",
"loyalty_reward_name": "<string>",
"offer_id": "<string>",
"order_loyalty_reward_id": "<string>"
}
],
"loyalty_rewards_total": "199.99",
"product": {
"id": "<string>",
"barcode": "<string>",
"brand": "<string>",
"ebt_enabled": true,
"name": "<string>",
"sold_by_weight": true,
"unit_of_measure": "<string>",
"unit_of_measure_amount": "199.99",
"wic_enabled": true
},
"promo_savings": "199.99",
"promotions": [
{
"id": "<string>",
"amount": "199.99",
"display_text": "<string>",
"offer_id": "<string>",
"promotion_id": "<string>",
"savings": "199.99"
}
],
"quantity": "199.99",
"refunded_order_line_item_id": "<string>",
"retail_price": "199.99",
"retail_total": "199.99",
"subtotal": "199.99",
"tax_total": "199.99",
"taxable_amount": "199.99",
"taxes": [
{
"id": "<string>",
"amount": "199.99",
"tax_rate": {
"id": "<string>",
"category": "other",
"name": "<string>",
"value": "8.25",
"value_type": "amount"
}
}
],
"total": "199.99",
"transaction_type": "refund",
"type": "refund",
"variable_weights": [
{
"id": "<string>",
"variable_weight": {
"id": "<string>",
"name": "<string>",
"unit": "LBS",
"value": "199.99"
}
}
],
"wic_adjusted_price": "199.99"
}
],
"loyalty_rewards_total": "199.99",
"metadata": {
"order_source": "shopify",
"fulfillment_id": "88213"
},
"payments": [
{
"id": "<string>",
"authorized_amount": "199.99",
"card_brand": "american_express",
"card_last4": "<string>",
"cash_received": "199.99",
"cashback_amount": "199.99",
"change_returned": "199.99",
"completed_at": "2023-11-07T05:31:56Z",
"payment_type": "cash",
"requested_amount": "199.99",
"reversals": [
{
"id": "<string>",
"authorized_amount": "199.99",
"card_brand": "american_express",
"card_last4": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"payment_type": "cash",
"requested_amount": "199.99"
}
],
"terminal_was_online": true,
"till_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tip_amount": "199.99"
}
],
"points_earned": "199.99",
"promo_savings": "199.99",
"promo_total": "199.99",
"receipt_type": "email",
"refund_total": "199.99",
"refunds": [
{
"id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"employee_id": "<string>",
"lane_id": "<string>",
"shopper_facing_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"store_id": "<string>",
"subtotal": "199.99",
"tax_total": "199.99",
"total": "199.99"
}
],
"retail_total": "199.99",
"shopper_facing_id": "<string>",
"shopper_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "api",
"started_at": "2023-11-07T05:31:56Z",
"status": "completed",
"store_id": "<string>",
"subtotal": "199.99",
"tax_total": "199.99",
"taxable_amount": "199.99",
"tip_amount": "199.99",
"total": "199.99",
"total_collected": "199.99",
"type": "refund"
}{
"error_code": "insufficient_permissions",
"error_details": {
"action": "*",
"resource": "*"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
A completed checkout at a store, covering the lane, cashier, and shopper, the products sold, the savings applied, the payments collected, and any refunds against it.
Unique identifier for the record.
Cash back requested by the shopper.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Date and time when the transaction was finalized.
Total savings from coupons.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Total savings from manual or employee discounts.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
ID of the employee who processed the transaction.
Pattern:
^[0-9]+$Your own identifier for the transaction, as supplied when it was recorded.
Gift cards purchased in the transaction.
Show child attributes
Show child attributes
Total face value of gift cards purchased in the transaction.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Coupons issued to the shopper by the transaction.
Show child attributes
Show child attributes
Total value of item modifiers.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
ID of the checkout lane that processed the transaction.
Pattern:
^[0-9]+$Product line items included in the transaction.
Show child attributes
Show child attributes
Total savings from loyalty reward redemptions.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Your own key/value pairs, exactly as supplied when the transaction was recorded.
Show child attributes
Show child attributes
Example:
{
"order_source": "shopify",
"fulfillment_id": "88213"
}
Payments collected for the transaction.
Show child attributes
Show child attributes
Loyalty points the shopper earned on this transaction, computed from the products sold and the store banner loyalty program. Zero when the transaction names no shopper or the banner has no active loyalty program. Negative on a refund, which reverses the points the original sale earned.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Total savings from promotions.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Sum of line-item totals after promotions are applied.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
How the shopper took their receipt, or null when they took none.
Available options:
email, print, sms Total value refunded against this transaction.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Refunds of the transaction. Retrieve one with GET /v1/transactions/{id} for the products returned and how the money went back.
Show child attributes
Show child attributes
Sum of line-item retail totals after promotions and before discounts and tax.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Human-readable transaction identifier shown to the shopper.
ID of the loyalty shopper associated with the transaction, or null for an anonymous transaction.
Where the transaction came from.
Available options:
api, migration, pos Date and time when the cashier started the transaction.
Current lifecycle status of the transaction.
Available options:
completed, expired, suspended, voided ID of the store where the transaction was placed.
Pattern:
^[0-9]+$Sum of line-item subtotals before promotions, discounts, and tax.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Total tax charged on the transaction.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Portion of the transaction subject to tax.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Tip added by the shopper.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Final transaction amount including tax. Sales are positive and refunds are negative.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Total collected from the shopper, including the transaction total, tip, and cash back.
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Financial transaction type represented by the transaction.
Available options:
refund, sale, void Was this page helpful?