Browse Profile Transactions
curl --request GET \
--url https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactionsimport requests
url = "https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions', 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.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions"
req, _ := http.NewRequest("GET", url, nil)
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.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"external_id": "<string>",
"redemption": {
"id": 123,
"type": "<string>",
"total": "<string>",
"total_localised": "<string>",
"location_id": 123,
"location": {
"id": "<string>",
"name": "<string>",
"external_id": "<string>"
},
"items": [
{
"id": 123,
"type": "<string>",
"value": 123,
"count": 123,
"type_attributes": {
"id": 123,
"profile_id": "<string>",
"creator_profile_id": "<string>",
"staff_id": "<string>",
"location_id": 123,
"name": "<string>",
"credit_definition_id": 123,
"timezone": "<string>",
"recipient_first_name": "<string>",
"recipient_email": "<string>",
"message": "<string>",
"issued_at": "<string>",
"expires_at": "<string>",
"released_at": "<string>",
"extended_at": "<string>",
"value_initial": "<string>",
"value_remaining": "<string>",
"external_id": "<string>",
"external_namespace": "<string>",
"credit_number": "<string>",
"security_code": "<string>",
"source_id": 123,
"source_type": "<string>",
"locked": true,
"lock_expires_at": "<string>",
"has_notified_issue": true,
"has_notified_expiry": true,
"has_notified_release": true,
"has_notified_remind": true,
"has_notified_extend": true,
"meta": [
"<unknown>"
],
"is_imported": true,
"is_system_generated": true,
"created_at": "<string>",
"updated_at": "<string>",
"definition": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"region_id": 123,
"region": {
"id": 123,
"name": "<string>",
"handle": "<string>"
},
"timezone": "<string>",
"period": 123,
"period_type": "<string>",
"absolute_expiry": "<string>",
"release_period": 123,
"release_period_type": "<string>",
"release_period_absolute_expiry": "<string>",
"is_published": true,
"is_archived": true,
"icon": "<string>",
"image_url": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"description": "<string>",
"internal_notes": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"earn_instructions": "<string>",
"meta": [
"<unknown>"
],
"type": "<string>",
"value": 123,
"max_value": 123,
"currency_id": 123,
"currency": "<string>",
"require_creator": true,
"require_assigned": true,
"is_extendable": true,
"is_assignable": true,
"is_releasable": true,
"is_reassignable": true,
"require_security_code": true,
"extend_days": 123,
"credit_number_range_type": "<string>",
"credit_number_range_start": "<string>",
"credit_number_range_end": "<string>",
"credit_number_length": 123,
"security_code_type": "<string>",
"use_custom_numbers": true,
"notify_schedule_offset": 123,
"issue_target_id": 123,
"expiry_target_id": 123,
"release_target_id": 123,
"remind_target_id": 123,
"extend_target_id": 123,
"notify_issue_offset_days": 123,
"notify_issue_offset_hour": 123,
"notify_remind_offset_days": 123,
"notify_remind_offset_hour": 123,
"tags": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>",
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_index": "<string>"
}
]
}
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"reversed_redemptions": [
{
"id": 123,
"profile_id": "<string>",
"profile": {
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"statuses": [
"<unknown>"
]
},
"type": "<string>",
"total": "<string>",
"total_localised": "<string>",
"meta": [
"<unknown>"
],
"location_id": 123,
"location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"external_id": "<string>",
"is_published": true,
"is_permanently_closed": true
},
"transaction_id": "<string>",
"items": [
{
"id": 123,
"type": "<string>",
"value": 123,
"count": 123,
"type_attributes": {
"id": 123,
"profile_id": "<string>",
"creator_profile_id": "<string>",
"staff_id": "<string>",
"location_id": 123,
"name": "<string>",
"credit_definition_id": 123,
"timezone": "<string>",
"recipient_first_name": "<string>",
"recipient_email": "<string>",
"message": "<string>",
"issued_at": "<string>",
"expires_at": "<string>",
"released_at": "<string>",
"extended_at": "<string>",
"value_initial": "<string>",
"value_remaining": "<string>",
"external_id": "<string>",
"external_namespace": "<string>",
"credit_number": "<string>",
"security_code": "<string>",
"source_id": 123,
"source_type": "<string>",
"locked": true,
"lock_expires_at": "<string>",
"has_notified_issue": true,
"has_notified_expiry": true,
"has_notified_release": true,
"has_notified_remind": true,
"has_notified_extend": true,
"meta": [
"<unknown>"
],
"is_imported": true,
"is_system_generated": true,
"created_at": "<string>",
"updated_at": "<string>",
"definition": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"region_id": 123,
"region": {
"id": 123,
"name": "<string>",
"handle": "<string>"
},
"timezone": "<string>",
"period": 123,
"period_type": "<string>",
"absolute_expiry": "<string>",
"release_period": 123,
"release_period_type": "<string>",
"release_period_absolute_expiry": "<string>",
"is_published": true,
"is_archived": true,
"icon": "<string>",
"image_url": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"description": "<string>",
"internal_notes": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"earn_instructions": "<string>",
"meta": [
"<unknown>"
],
"type": "<string>",
"value": 123,
"max_value": 123,
"currency_id": 123,
"currency": "<string>",
"require_creator": true,
"require_assigned": true,
"is_extendable": true,
"is_assignable": true,
"is_releasable": true,
"is_reassignable": true,
"require_security_code": true,
"extend_days": 123,
"credit_number_range_type": "<string>",
"credit_number_range_start": "<string>",
"credit_number_range_end": "<string>",
"credit_number_length": 123,
"security_code_type": "<string>",
"use_custom_numbers": true,
"notify_schedule_offset": 123,
"issue_target_id": 123,
"expiry_target_id": 123,
"release_target_id": 123,
"remind_target_id": 123,
"extend_target_id": 123,
"notify_issue_offset_days": 123,
"notify_issue_offset_hour": 123,
"notify_remind_offset_days": 123,
"notify_remind_offset_hour": 123,
"tags": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>",
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_index": "<string>"
}
]
}
},
"created_at": "<string>",
"updated_at": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>",
"redeem_at": "<string>",
"transaction": {
"external_id": "<string>",
"receipt_ref": "<string>",
"transacted_at": "<string>",
"total": 123,
"location": {
"id": "<string>",
"name": "<string>",
"external_id": "<string>"
}
}
}
],
"profile_id": "<string>",
"profile": null,
"location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"external_id": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
}
},
"meta": [
"<unknown>"
],
"total": 123,
"total_original": 123,
"total_converted": 123,
"systems": [
"<unknown>"
],
"rounding": 123,
"margin": 123,
"is_void": true,
"transacted_at": "<string>",
"timezone": "<string>",
"tags": [
"<string>"
],
"items": [
{
"id": 123,
"external_id": "<string>",
"name": "<string>",
"transaction_id": 123,
"product_id": 123,
"product_variant_id": 123,
"sku": "<string>",
"variant_external_id": "<string>",
"is_void": true,
"quantity": 123,
"price_current": 123,
"price_sell": 123,
"price_original": 123,
"price_margin": 123,
"price_tax": 123,
"is_return": "<string>",
"discounts": [
"<unknown>"
],
"department": "<string>",
"meta": [
"<unknown>"
],
"product_images": {},
"order_id": 123,
"created_at": "<string>",
"updated_at": "<string>",
"pivot": {
"created_at": "<string>",
"updated_at": "<string>"
},
"product_variant": {
"id": 123,
"product_id": 123,
"sku": "<string>",
"external_id": "<string>",
"barcode": "<string>",
"web_url": "<string>",
"handle": "<string>",
"title": "<string>",
"description": "<string>",
"position": 123,
"price": 123,
"price_discounted": 123,
"price_comparison": 123,
"price_cost": 123,
"available_quantity": 123,
"images": "<string>",
"meta": [
"<unknown>"
],
"tags": [
"<string>"
],
"options": [
{
"name": "<string>",
"value": "<string>",
"sort_order": 123
}
],
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"product": {
"title": "<string>",
"department": "<string>",
"brand": "<string>",
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable": {
"id": "<string>",
"external_id": "<string>",
"profile_id": "<string>",
"meta": "<string>",
"total": "<string>",
"total_original": "<string>",
"rounding": "<string>",
"margin": "<string>",
"is_void": "<string>",
"transacted_at": "<string>",
"timezone": "<string>",
"payments": "<string>",
"receipt_is_email": "<string>",
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"claimed_at": "<string>",
"receipt_email": "<string>",
"currency_id": "<string>",
"currency_rate": "<string>",
"currency": "<string>",
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": "<string>",
"external_order_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"is_index": 123
}
]
},
"transaction": {
"transacted_at": "<string>",
"receipt_ref": "<string>",
"external_id": "<string>",
"location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"external_id": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
}
}
},
"list_items": [
{
"id": "<string>",
"product_list_id": "<string>",
"list": {
"name": "<string>",
"handle": "<string>",
"description": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"quantity": "<string>",
"position": "<string>",
"status": "<string>",
"meta": "<string>",
"pivot": {
"created_at": "<string>",
"updated_at": "<string>"
}
}
]
}
],
"payments": [
"<unknown>"
],
"receipt_is_email": true,
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"claimed_at": "<string>",
"receipt_email": "<string>",
"staff": {
"id": "<string>",
"full_name": "<string>",
"email": "<string>",
"identities": [
{
"id": 123,
"handle": "<string>",
"identifier": "<string>",
"is_primary": true,
"is_active": true,
"profile_id": "<string>",
"merged_from": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"profile": {
"id": "<string>",
"external_id": "<string>",
"title": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"gender": "<string>",
"currency": "<string>",
"joined_at": "<string>",
"mobile_phone": "<string>",
"mobile_phone_country": "<string>",
"mobile_phone_national": "<string>",
"mobile_phone_national_prefix": [
"<unknown>"
],
"mobile_phone_e164": "<string>",
"secondary_phone": "<string>",
"birth_year": "<string>",
"birth_month": "<string>",
"birth_day": "<string>",
"company": "<string>",
"occupation": "<string>",
"avatar_url": "<string>",
"preferred_location_id": "<string>",
"joined_location_id": "<string>",
"joined_location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"preferred_location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"tier_handle": "<string>",
"tier": {
"id": 123,
"profile_id": "<string>",
"name": "<string>",
"handle": "<string>",
"anniversary_at": "<string>",
"maintained_at": "<string>",
"assigned_at": "<string>",
"achieved_at": "<string>"
},
"birth_date": "<string>",
"birth_days": "<string>",
"birth_days_past": "<string>",
"next_birthday": "<string>",
"tags": [
"<string>"
],
"attributes": {
"comms": [
"<unknown>"
],
"appearance": {
"profile_id": "<string>",
"hair_colour": "<string>",
"hair_length": "<string>",
"shape_body": "<string>",
"shape_face": "<string>",
"size_cup": "<string>",
"size_hat": "<string>",
"size_formal_jacket": "<string>",
"size_formal_jacket_length": "<string>",
"size_formal_shirt": "<string>",
"size_formal_shirt_fit": "<string>",
"size_formal_trouser": "<string>",
"size_formal_trouser_drop": "<string>",
"size_formal_trouser_leg": "<string>",
"size_jacket": "<string>",
"size_pant": "<string>",
"size_shoe": "<string>",
"size_type_age": "<string>",
"size_type_region": "<string>",
"size_top": "<string>",
"size_gloves": "<string>",
"size_swimwear_top": "<string>",
"size_swimwear_bottom": "<string>",
"size_swimwear_cup": "<string>",
"size_dress": "<string>",
"skin_type": "<string>",
"measurement_arm": "<string>",
"measurement_arm_inside": "<string>",
"measurement_bust": "<string>",
"measurement_chest": "<string>",
"measurement_foot_length": "<string>",
"measurement_head": "<string>",
"measurement_height": "<string>",
"measurement_hip": "<string>",
"measurement_leg_inside": "<string>",
"measurement_leg_outside": "<string>",
"measurement_neck": "<string>",
"measurement_neck_to_wrist": "<string>",
"measurement_shoulders": "<string>",
"measurement_waist": "<string>",
"measurement_weight": "<string>",
"brow_colour": "<string>",
"eye_colour": "<string>",
"measurement_hand_right_thumb": "<string>",
"measurement_hand_right_index": "<string>",
"measurement_hand_right_middle": "<string>",
"measurement_hand_right_ring": "<string>",
"measurement_hand_right_pinky": "<string>",
"measurement_hand_left_thumb": "<string>",
"measurement_hand_left_index": "<string>",
"measurement_hand_left_middle": "<string>",
"measurement_hand_left_ring": "<string>",
"measurement_hand_left_pinky": "<string>",
"measurement_ear_helix": "<string>",
"measurement_ear_forward_helix": "<string>",
"measurement_ear_flat": "<string>",
"measurement_ear_conch": "<string>",
"measurement_ear_tragus": "<string>",
"measurement_ear_lobe": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"dates": [
{
"id": "<string>",
"profile_id": "<string>",
"date": "<string>",
"is_recurring": "<string>",
"recurring_schedule": "<string>",
"name": "<string>",
"handle": "<string>",
"relationship": "<string>",
"role": "<string>",
"description": "<string>",
"meta": "<string>",
"note": "<string>",
"links": [
{
"id": "<string>",
"attributes_date_id": "<string>",
"profile_id": "<string>",
"relationship": "<string>",
"role": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"statuses": [
"<unknown>"
],
"statuses_original": [
{
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"sort_order": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"colour": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"internal_notes": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": "<string>",
"period_type": "<string>",
"absolute_expiry": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"custom_attributes": "<string>",
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"addresses": [
{
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
}
],
"reward_balance": "<string>",
"point_balance": "<string>",
"benefit_balance": "<string>",
"combined_balance_dollars": "<string>",
"point_balance_dollars": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"profile_type": "<string>",
"region": {
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"is_active": "<string>",
"country": "<string>",
"state": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"regions": [
{
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"is_active": "<string>",
"country": "<string>",
"state": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
}
]
},
"currency_id": 123,
"currency_rate": 123,
"currency": "<string>",
"currency_values": [
{
"id": 123,
"from": "<string>",
"to": "<string>",
"rate": 123,
"total": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
],
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": 123,
"external_order_id": "<string>",
"need_action": true,
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable": {
"id": "<string>",
"external_id": "<string>",
"profile_id": "<string>",
"meta": "<string>",
"total": "<string>",
"total_original": "<string>",
"rounding": "<string>",
"margin": "<string>",
"is_void": "<string>",
"transacted_at": "<string>",
"timezone": "<string>",
"payments": "<string>",
"receipt_is_email": "<string>",
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"claimed_at": "<string>",
"receipt_email": "<string>",
"currency_id": "<string>",
"currency_rate": "<string>",
"currency": "<string>",
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": "<string>",
"external_order_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"is_index": 123
}
],
"organisation": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"type": "<string>",
"status": "<string>",
"is_tenant": 123,
"is_active": 123,
"phone": "<string>",
"email": "<string>",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": [
"<unknown>"
],
"meta": [
"<unknown>"
],
"locations": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
],
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"custom_fields": {},
"created_at": "<string>",
"updated_at": "<string>"
},
"fees": [
"<unknown>"
],
"created_at": "<string>",
"updated_at": "<string>",
"tier_points": [
{
"id": "<string>",
"profile_id": "<string>",
"point_definition_id": "<string>",
"value": "<string>",
"issued_at": "<string>",
"accrued_at": "<string>",
"status": "<string>",
"source_id": "<string>",
"source_type": "<string>",
"meta": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Profile Transaction
Browse Profile Transactions
A GET to the /profiles/{profileId}/transactions endpoint allows your application to retrieve all Transactions associated with a Profile.
GET
/
v3
/
profiles
/
{profile}
/
transactions
Browse Profile Transactions
curl --request GET \
--url https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactionsimport requests
url = "https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions', 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.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions"
req, _ := http.NewRequest("GET", url, nil)
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.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/{profile}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"external_id": "<string>",
"redemption": {
"id": 123,
"type": "<string>",
"total": "<string>",
"total_localised": "<string>",
"location_id": 123,
"location": {
"id": "<string>",
"name": "<string>",
"external_id": "<string>"
},
"items": [
{
"id": 123,
"type": "<string>",
"value": 123,
"count": 123,
"type_attributes": {
"id": 123,
"profile_id": "<string>",
"creator_profile_id": "<string>",
"staff_id": "<string>",
"location_id": 123,
"name": "<string>",
"credit_definition_id": 123,
"timezone": "<string>",
"recipient_first_name": "<string>",
"recipient_email": "<string>",
"message": "<string>",
"issued_at": "<string>",
"expires_at": "<string>",
"released_at": "<string>",
"extended_at": "<string>",
"value_initial": "<string>",
"value_remaining": "<string>",
"external_id": "<string>",
"external_namespace": "<string>",
"credit_number": "<string>",
"security_code": "<string>",
"source_id": 123,
"source_type": "<string>",
"locked": true,
"lock_expires_at": "<string>",
"has_notified_issue": true,
"has_notified_expiry": true,
"has_notified_release": true,
"has_notified_remind": true,
"has_notified_extend": true,
"meta": [
"<unknown>"
],
"is_imported": true,
"is_system_generated": true,
"created_at": "<string>",
"updated_at": "<string>",
"definition": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"region_id": 123,
"region": {
"id": 123,
"name": "<string>",
"handle": "<string>"
},
"timezone": "<string>",
"period": 123,
"period_type": "<string>",
"absolute_expiry": "<string>",
"release_period": 123,
"release_period_type": "<string>",
"release_period_absolute_expiry": "<string>",
"is_published": true,
"is_archived": true,
"icon": "<string>",
"image_url": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"description": "<string>",
"internal_notes": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"earn_instructions": "<string>",
"meta": [
"<unknown>"
],
"type": "<string>",
"value": 123,
"max_value": 123,
"currency_id": 123,
"currency": "<string>",
"require_creator": true,
"require_assigned": true,
"is_extendable": true,
"is_assignable": true,
"is_releasable": true,
"is_reassignable": true,
"require_security_code": true,
"extend_days": 123,
"credit_number_range_type": "<string>",
"credit_number_range_start": "<string>",
"credit_number_range_end": "<string>",
"credit_number_length": 123,
"security_code_type": "<string>",
"use_custom_numbers": true,
"notify_schedule_offset": 123,
"issue_target_id": 123,
"expiry_target_id": 123,
"release_target_id": 123,
"remind_target_id": 123,
"extend_target_id": 123,
"notify_issue_offset_days": 123,
"notify_issue_offset_hour": 123,
"notify_remind_offset_days": 123,
"notify_remind_offset_hour": 123,
"tags": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>",
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_index": "<string>"
}
]
}
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"reversed_redemptions": [
{
"id": 123,
"profile_id": "<string>",
"profile": {
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"statuses": [
"<unknown>"
]
},
"type": "<string>",
"total": "<string>",
"total_localised": "<string>",
"meta": [
"<unknown>"
],
"location_id": 123,
"location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"external_id": "<string>",
"is_published": true,
"is_permanently_closed": true
},
"transaction_id": "<string>",
"items": [
{
"id": 123,
"type": "<string>",
"value": 123,
"count": 123,
"type_attributes": {
"id": 123,
"profile_id": "<string>",
"creator_profile_id": "<string>",
"staff_id": "<string>",
"location_id": 123,
"name": "<string>",
"credit_definition_id": 123,
"timezone": "<string>",
"recipient_first_name": "<string>",
"recipient_email": "<string>",
"message": "<string>",
"issued_at": "<string>",
"expires_at": "<string>",
"released_at": "<string>",
"extended_at": "<string>",
"value_initial": "<string>",
"value_remaining": "<string>",
"external_id": "<string>",
"external_namespace": "<string>",
"credit_number": "<string>",
"security_code": "<string>",
"source_id": 123,
"source_type": "<string>",
"locked": true,
"lock_expires_at": "<string>",
"has_notified_issue": true,
"has_notified_expiry": true,
"has_notified_release": true,
"has_notified_remind": true,
"has_notified_extend": true,
"meta": [
"<unknown>"
],
"is_imported": true,
"is_system_generated": true,
"created_at": "<string>",
"updated_at": "<string>",
"definition": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"region_id": 123,
"region": {
"id": 123,
"name": "<string>",
"handle": "<string>"
},
"timezone": "<string>",
"period": 123,
"period_type": "<string>",
"absolute_expiry": "<string>",
"release_period": 123,
"release_period_type": "<string>",
"release_period_absolute_expiry": "<string>",
"is_published": true,
"is_archived": true,
"icon": "<string>",
"image_url": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"description": "<string>",
"internal_notes": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"earn_instructions": "<string>",
"meta": [
"<unknown>"
],
"type": "<string>",
"value": 123,
"max_value": 123,
"currency_id": 123,
"currency": "<string>",
"require_creator": true,
"require_assigned": true,
"is_extendable": true,
"is_assignable": true,
"is_releasable": true,
"is_reassignable": true,
"require_security_code": true,
"extend_days": 123,
"credit_number_range_type": "<string>",
"credit_number_range_start": "<string>",
"credit_number_range_end": "<string>",
"credit_number_length": 123,
"security_code_type": "<string>",
"use_custom_numbers": true,
"notify_schedule_offset": 123,
"issue_target_id": 123,
"expiry_target_id": 123,
"release_target_id": 123,
"remind_target_id": 123,
"extend_target_id": 123,
"notify_issue_offset_days": 123,
"notify_issue_offset_hour": 123,
"notify_remind_offset_days": 123,
"notify_remind_offset_hour": 123,
"tags": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>",
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_index": "<string>"
}
]
}
},
"created_at": "<string>",
"updated_at": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>",
"redeem_at": "<string>",
"transaction": {
"external_id": "<string>",
"receipt_ref": "<string>",
"transacted_at": "<string>",
"total": 123,
"location": {
"id": "<string>",
"name": "<string>",
"external_id": "<string>"
}
}
}
],
"profile_id": "<string>",
"profile": null,
"location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"external_id": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
}
},
"meta": [
"<unknown>"
],
"total": 123,
"total_original": 123,
"total_converted": 123,
"systems": [
"<unknown>"
],
"rounding": 123,
"margin": 123,
"is_void": true,
"transacted_at": "<string>",
"timezone": "<string>",
"tags": [
"<string>"
],
"items": [
{
"id": 123,
"external_id": "<string>",
"name": "<string>",
"transaction_id": 123,
"product_id": 123,
"product_variant_id": 123,
"sku": "<string>",
"variant_external_id": "<string>",
"is_void": true,
"quantity": 123,
"price_current": 123,
"price_sell": 123,
"price_original": 123,
"price_margin": 123,
"price_tax": 123,
"is_return": "<string>",
"discounts": [
"<unknown>"
],
"department": "<string>",
"meta": [
"<unknown>"
],
"product_images": {},
"order_id": 123,
"created_at": "<string>",
"updated_at": "<string>",
"pivot": {
"created_at": "<string>",
"updated_at": "<string>"
},
"product_variant": {
"id": 123,
"product_id": 123,
"sku": "<string>",
"external_id": "<string>",
"barcode": "<string>",
"web_url": "<string>",
"handle": "<string>",
"title": "<string>",
"description": "<string>",
"position": 123,
"price": 123,
"price_discounted": 123,
"price_comparison": 123,
"price_cost": 123,
"available_quantity": 123,
"images": "<string>",
"meta": [
"<unknown>"
],
"tags": [
"<string>"
],
"options": [
{
"name": "<string>",
"value": "<string>",
"sort_order": 123
}
],
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"product": {
"title": "<string>",
"department": "<string>",
"brand": "<string>",
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable": {
"id": "<string>",
"external_id": "<string>",
"profile_id": "<string>",
"meta": "<string>",
"total": "<string>",
"total_original": "<string>",
"rounding": "<string>",
"margin": "<string>",
"is_void": "<string>",
"transacted_at": "<string>",
"timezone": "<string>",
"payments": "<string>",
"receipt_is_email": "<string>",
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"claimed_at": "<string>",
"receipt_email": "<string>",
"currency_id": "<string>",
"currency_rate": "<string>",
"currency": "<string>",
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": "<string>",
"external_order_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"is_index": 123
}
]
},
"transaction": {
"transacted_at": "<string>",
"receipt_ref": "<string>",
"external_id": "<string>",
"location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"external_id": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
}
}
},
"list_items": [
{
"id": "<string>",
"product_list_id": "<string>",
"list": {
"name": "<string>",
"handle": "<string>",
"description": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"quantity": "<string>",
"position": "<string>",
"status": "<string>",
"meta": "<string>",
"pivot": {
"created_at": "<string>",
"updated_at": "<string>"
}
}
]
}
],
"payments": [
"<unknown>"
],
"receipt_is_email": true,
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"claimed_at": "<string>",
"receipt_email": "<string>",
"staff": {
"id": "<string>",
"full_name": "<string>",
"email": "<string>",
"identities": [
{
"id": 123,
"handle": "<string>",
"identifier": "<string>",
"is_primary": true,
"is_active": true,
"profile_id": "<string>",
"merged_from": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"profile": {
"id": "<string>",
"external_id": "<string>",
"title": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"gender": "<string>",
"currency": "<string>",
"joined_at": "<string>",
"mobile_phone": "<string>",
"mobile_phone_country": "<string>",
"mobile_phone_national": "<string>",
"mobile_phone_national_prefix": [
"<unknown>"
],
"mobile_phone_e164": "<string>",
"secondary_phone": "<string>",
"birth_year": "<string>",
"birth_month": "<string>",
"birth_day": "<string>",
"company": "<string>",
"occupation": "<string>",
"avatar_url": "<string>",
"preferred_location_id": "<string>",
"joined_location_id": "<string>",
"joined_location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"preferred_location": {
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"tier_handle": "<string>",
"tier": {
"id": 123,
"profile_id": "<string>",
"name": "<string>",
"handle": "<string>",
"anniversary_at": "<string>",
"maintained_at": "<string>",
"assigned_at": "<string>",
"achieved_at": "<string>"
},
"birth_date": "<string>",
"birth_days": "<string>",
"birth_days_past": "<string>",
"next_birthday": "<string>",
"tags": [
"<string>"
],
"attributes": {
"comms": [
"<unknown>"
],
"appearance": {
"profile_id": "<string>",
"hair_colour": "<string>",
"hair_length": "<string>",
"shape_body": "<string>",
"shape_face": "<string>",
"size_cup": "<string>",
"size_hat": "<string>",
"size_formal_jacket": "<string>",
"size_formal_jacket_length": "<string>",
"size_formal_shirt": "<string>",
"size_formal_shirt_fit": "<string>",
"size_formal_trouser": "<string>",
"size_formal_trouser_drop": "<string>",
"size_formal_trouser_leg": "<string>",
"size_jacket": "<string>",
"size_pant": "<string>",
"size_shoe": "<string>",
"size_type_age": "<string>",
"size_type_region": "<string>",
"size_top": "<string>",
"size_gloves": "<string>",
"size_swimwear_top": "<string>",
"size_swimwear_bottom": "<string>",
"size_swimwear_cup": "<string>",
"size_dress": "<string>",
"skin_type": "<string>",
"measurement_arm": "<string>",
"measurement_arm_inside": "<string>",
"measurement_bust": "<string>",
"measurement_chest": "<string>",
"measurement_foot_length": "<string>",
"measurement_head": "<string>",
"measurement_height": "<string>",
"measurement_hip": "<string>",
"measurement_leg_inside": "<string>",
"measurement_leg_outside": "<string>",
"measurement_neck": "<string>",
"measurement_neck_to_wrist": "<string>",
"measurement_shoulders": "<string>",
"measurement_waist": "<string>",
"measurement_weight": "<string>",
"brow_colour": "<string>",
"eye_colour": "<string>",
"measurement_hand_right_thumb": "<string>",
"measurement_hand_right_index": "<string>",
"measurement_hand_right_middle": "<string>",
"measurement_hand_right_ring": "<string>",
"measurement_hand_right_pinky": "<string>",
"measurement_hand_left_thumb": "<string>",
"measurement_hand_left_index": "<string>",
"measurement_hand_left_middle": "<string>",
"measurement_hand_left_ring": "<string>",
"measurement_hand_left_pinky": "<string>",
"measurement_ear_helix": "<string>",
"measurement_ear_forward_helix": "<string>",
"measurement_ear_flat": "<string>",
"measurement_ear_conch": "<string>",
"measurement_ear_tragus": "<string>",
"measurement_ear_lobe": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"dates": [
{
"id": "<string>",
"profile_id": "<string>",
"date": "<string>",
"is_recurring": "<string>",
"recurring_schedule": "<string>",
"name": "<string>",
"handle": "<string>",
"relationship": "<string>",
"role": "<string>",
"description": "<string>",
"meta": "<string>",
"note": "<string>",
"links": [
{
"id": "<string>",
"attributes_date_id": "<string>",
"profile_id": "<string>",
"relationship": "<string>",
"role": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>"
}
]
},
"statuses": [
"<unknown>"
],
"statuses_original": [
{
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"sort_order": "<string>",
"description": "<string>",
"short_description": "<string>",
"long_description": "<string>",
"terms_conditions": "<string>",
"icon": "<string>",
"image_url": "<string>",
"earn_instructions": "<string>",
"colour": "<string>",
"primary_colour": "<string>",
"secondary_colour": "<string>",
"text_colour": "<string>",
"code": "<string>",
"internal_notes": "<string>",
"group_name": "<string>",
"group_handle": "<string>",
"timezone": "<string>",
"period": "<string>",
"period_type": "<string>",
"absolute_expiry": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"custom_attributes": "<string>",
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"addresses": [
{
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
}
],
"reward_balance": "<string>",
"point_balance": "<string>",
"benefit_balance": "<string>",
"combined_balance_dollars": "<string>",
"point_balance_dollars": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"profile_type": "<string>",
"region": {
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"is_active": "<string>",
"country": "<string>",
"state": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"regions": [
{
"id": "<string>",
"name": "<string>",
"handle": "<string>",
"is_active": "<string>",
"country": "<string>",
"state": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
}
]
},
"currency_id": 123,
"currency_rate": 123,
"currency": "<string>",
"currency_values": [
{
"id": 123,
"from": "<string>",
"to": "<string>",
"rate": 123,
"total": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
],
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": 123,
"external_order_id": "<string>",
"need_action": true,
"custom_fields": [
{
"name": "<string>",
"handle": "<string>",
"namespace": "<string>",
"value": "<string>",
"type": "<string>",
"custom_fieldable_type": "<string>",
"custom_fieldable": {
"id": "<string>",
"external_id": "<string>",
"profile_id": "<string>",
"meta": "<string>",
"total": "<string>",
"total_original": "<string>",
"rounding": "<string>",
"margin": "<string>",
"is_void": "<string>",
"transacted_at": "<string>",
"timezone": "<string>",
"payments": "<string>",
"receipt_is_email": "<string>",
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"claimed_at": "<string>",
"receipt_email": "<string>",
"currency_id": "<string>",
"currency_rate": "<string>",
"currency": "<string>",
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": "<string>",
"external_order_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"is_index": 123
}
],
"organisation": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"type": "<string>",
"status": "<string>",
"is_tenant": 123,
"is_active": 123,
"phone": "<string>",
"email": "<string>",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": [
"<unknown>"
],
"meta": [
"<unknown>"
],
"locations": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
],
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"custom_fields": {},
"created_at": "<string>",
"updated_at": "<string>"
},
"fees": [
"<unknown>"
],
"created_at": "<string>",
"updated_at": "<string>",
"tier_points": [
{
"id": "<string>",
"profile_id": "<string>",
"point_definition_id": "<string>",
"value": "<string>",
"issued_at": "<string>",
"accrued_at": "<string>",
"status": "<string>",
"source_id": "<string>",
"source_type": "<string>",
"meta": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Filtering
This endpoint accepts
filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.Examples
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles/{profile}/transactions?filter[external_id]={external_id}" \
-H "Authorization: Bearer ${TOKEN}"
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles/{profile}/transactions?filter[deliver_at][gte]=2026-01-01&filter[deliver_at][lt]=2026-02-01" \
-H "Authorization: Bearer ${TOKEN}"
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles/{profile}/transactions?filter[systems.handle]={handle}" \
-H "Authorization: Bearer ${TOKEN}"
Operators
| Operator | Meaning | Example |
|---|---|---|
eq | Equal to. Applied when you give no operator. | filter[external_id]={external_id} |
ne | Not equal to. | filter[external_id][ne]={external_id} |
gt | Greater than. | filter[deliver_at][gt]=2026-01-01 |
gte | Greater than or equal to. | filter[deliver_at][gte]=2026-01-01 |
lt | Less than. | filter[deliver_at][lt]=2026-02-01 |
lte | Less than or equal to. | filter[deliver_at][lte]=2026-02-01 |
in | Matches any value in a comma separated list. | filter[id][in]=123,456 |
not_in | Excludes every value in a comma separated list. | filter[id][not_in]=123,456 |
nullable | 1 returns records where the attribute is empty. Any other value returns records where it is set. | filter[deliver_at][nullable]=1 |
not_has | Excludes records that have a matching related record. Related attributes only. | filter[systems.handle][not_has]={handle} |
Filter attributes
| Attribute | Attribute | Attribute |
|---|---|---|
id | profile_id | total |
rounding | total_original | margin |
external_id | redemption_id | deliver_at |
transacted_at | timezone | receipt_is_email |
receipt_ref | linked_receipt_ref | location_id |
type | status | order_number |
need_action | is_void |
sort key, for example ?sort=-deliver_at for descending order.
Related attributes
Dot notation filters on a related record. Usenot_has to exclude rows that have a matching related record. Related attributes are filter only, not sort keys.
| Attribute | Relationship |
|---|---|
systems.handle | systems |
tags.handle | tags |
location.name | location |
profile.identities.identifier | profile.identities |
Search attributes
filter[search] runs one partial match term across profile_id, external_id, receipt_ref, linked_receipt_ref. A record matches when any one of those attributes contains the term.
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles/{profile}/transactions?filter[search]={term}" \
-H "Authorization: Bearer ${TOKEN}"
Custom field filters
Transaction records carry custom fields, so this endpoint also acceptsfilter[custom_field][namespace:handle].
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles/{profile}/transactions?filter[custom_field][{namespace}:{handle}]={value}" \
-H "Authorization: Bearer ${TOKEN}"
Optional Parameters
?include=product Will add product_variant data to the returned payload.
This can be useful, if access to product variant data such as barcode, sku, and customisation options are needed on the transaction.⌘I