Skip to main content
PUT
/
v3
/
transactions
/
{transaction}
Edit Transaction
curl --request PUT \
  --url https://api.{tenant}.getomneo.com/api/v3/transactions/{transaction} \
  --header 'Content-Type: application/json' \
  --data '
{
  "profile_id": "<string>",
  "profile_id_handle": "<string>",
  "redemption_id": 123,
  "external_id": "<string>",
  "location_id": "<string>",
  "currency": "<string>",
  "total": 123,
  "total_original": 123,
  "rounding": 123,
  "tender": "<string>",
  "is_void": true,
  "margin": 123,
  "transacted_at": "<string>",
  "timezone": "<string>",
  "meta": [
    "<string>"
  ],
  "staff_id": "<string>",
  "payments": [
    "<string>"
  ],
  "receipt_is_email": true,
  "receipt_ref": "<string>",
  "linked_receipt_ref": "<string>",
  "receipt_email": "jsmith@example.com",
  "type": "<string>",
  "status": "<string>",
  "order_number": "<string>",
  "order_id": 123,
  "external_order_id": "<string>",
  "need_action": true,
  "organisation_id": 123,
  "fees": [
    "<string>"
  ],
  "currency_value": {
    "from": "<string>",
    "to": "<string>",
    "rate": 123
  },
  "tags": [
    "<string>"
  ],
  "systems": [
    "<string>"
  ],
  "items": [
    {
      "name": "<string>",
      "price_current": 123,
      "price_sell": 123,
      "quantity": 123,
      "external_id": "<string>",
      "price_original": 123,
      "price_margin": 123,
      "discounts": [
        "<string>"
      ],
      "sku": "<string>",
      "department": "<string>",
      "meta": [
        "<string>"
      ],
      "variant_external_id": "<string>",
      "product_variant_sku": "<string>",
      "product_variant_id": 123,
      "product_variant": {
        "product_id": "<string>",
        "sku": "<string>",
        "title": "<string>",
        "category": "<string>",
        "subcategory": "<string>",
        "brand": "<string>",
        "price": 123
      }
    }
  ],
  "custom_fields": [
    {
      "namespace": "<string>",
      "handle": "<string>",
      "value": "<string>"
    }
  ]
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/transactions/{transaction}"

payload = {
"profile_id": "<string>",
"profile_id_handle": "<string>",
"redemption_id": 123,
"external_id": "<string>",
"location_id": "<string>",
"currency": "<string>",
"total": 123,
"total_original": 123,
"rounding": 123,
"tender": "<string>",
"is_void": True,
"margin": 123,
"transacted_at": "<string>",
"timezone": "<string>",
"meta": ["<string>"],
"staff_id": "<string>",
"payments": ["<string>"],
"receipt_is_email": True,
"receipt_ref": "<string>",
"linked_receipt_ref": "<string>",
"receipt_email": "jsmith@example.com",
"type": "<string>",
"status": "<string>",
"order_number": "<string>",
"order_id": 123,
"external_order_id": "<string>",
"need_action": True,
"organisation_id": 123,
"fees": ["<string>"],
"currency_value": {
"from": "<string>",
"to": "<string>",
"rate": 123
},
"tags": ["<string>"],
"systems": ["<string>"],
"items": [
{
"name": "<string>",
"price_current": 123,
"price_sell": 123,
"quantity": 123,
"external_id": "<string>",
"price_original": 123,
"price_margin": 123,
"discounts": ["<string>"],
"sku": "<string>",
"department": "<string>",
"meta": ["<string>"],
"variant_external_id": "<string>",
"product_variant_sku": "<string>",
"product_variant_id": 123,
"product_variant": {
"product_id": "<string>",
"sku": "<string>",
"title": "<string>",
"category": "<string>",
"subcategory": "<string>",
"brand": "<string>",
"price": 123
}
}
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
profile_id: '<string>',
profile_id_handle: '<string>',
redemption_id: 123,
external_id: '<string>',
location_id: '<string>',
currency: '<string>',
total: 123,
total_original: 123,
rounding: 123,
tender: '<string>',
is_void: true,
margin: 123,
transacted_at: '<string>',
timezone: '<string>',
meta: ['<string>'],
staff_id: '<string>',
payments: ['<string>'],
receipt_is_email: true,
receipt_ref: '<string>',
linked_receipt_ref: '<string>',
receipt_email: 'jsmith@example.com',
type: '<string>',
status: '<string>',
order_number: '<string>',
order_id: 123,
external_order_id: '<string>',
need_action: true,
organisation_id: 123,
fees: ['<string>'],
currency_value: {from: '<string>', to: '<string>', rate: 123},
tags: ['<string>'],
systems: ['<string>'],
items: [
{
name: '<string>',
price_current: 123,
price_sell: 123,
quantity: 123,
external_id: '<string>',
price_original: 123,
price_margin: 123,
discounts: ['<string>'],
sku: '<string>',
department: '<string>',
meta: ['<string>'],
variant_external_id: '<string>',
product_variant_sku: '<string>',
product_variant_id: 123,
product_variant: {
product_id: '<string>',
sku: '<string>',
title: '<string>',
category: '<string>',
subcategory: '<string>',
brand: '<string>',
price: 123
}
}
],
custom_fields: [{namespace: '<string>', handle: '<string>', value: '<string>'}]
})
};

fetch('https://api.{tenant}.getomneo.com/api/v3/transactions/{transaction}', 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/transactions/{transaction}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'profile_id' => '<string>',
'profile_id_handle' => '<string>',
'redemption_id' => 123,
'external_id' => '<string>',
'location_id' => '<string>',
'currency' => '<string>',
'total' => 123,
'total_original' => 123,
'rounding' => 123,
'tender' => '<string>',
'is_void' => true,
'margin' => 123,
'transacted_at' => '<string>',
'timezone' => '<string>',
'meta' => [
'<string>'
],
'staff_id' => '<string>',
'payments' => [
'<string>'
],
'receipt_is_email' => true,
'receipt_ref' => '<string>',
'linked_receipt_ref' => '<string>',
'receipt_email' => 'jsmith@example.com',
'type' => '<string>',
'status' => '<string>',
'order_number' => '<string>',
'order_id' => 123,
'external_order_id' => '<string>',
'need_action' => true,
'organisation_id' => 123,
'fees' => [
'<string>'
],
'currency_value' => [
'from' => '<string>',
'to' => '<string>',
'rate' => 123
],
'tags' => [
'<string>'
],
'systems' => [
'<string>'
],
'items' => [
[
'name' => '<string>',
'price_current' => 123,
'price_sell' => 123,
'quantity' => 123,
'external_id' => '<string>',
'price_original' => 123,
'price_margin' => 123,
'discounts' => [
'<string>'
],
'sku' => '<string>',
'department' => '<string>',
'meta' => [
'<string>'
],
'variant_external_id' => '<string>',
'product_variant_sku' => '<string>',
'product_variant_id' => 123,
'product_variant' => [
'product_id' => '<string>',
'sku' => '<string>',
'title' => '<string>',
'category' => '<string>',
'subcategory' => '<string>',
'brand' => '<string>',
'price' => 123
]
]
],
'custom_fields' => [
[
'namespace' => '<string>',
'handle' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.{tenant}.getomneo.com/api/v3/transactions/{transaction}"

payload := strings.NewReader("{\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"redemption_id\": 123,\n \"external_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"total\": 123,\n \"total_original\": 123,\n \"rounding\": 123,\n \"tender\": \"<string>\",\n \"is_void\": true,\n \"margin\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"staff_id\": \"<string>\",\n \"payments\": [\n \"<string>\"\n ],\n \"receipt_is_email\": true,\n \"receipt_ref\": \"<string>\",\n \"linked_receipt_ref\": \"<string>\",\n \"receipt_email\": \"jsmith@example.com\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"order_number\": \"<string>\",\n \"order_id\": 123,\n \"external_order_id\": \"<string>\",\n \"need_action\": true,\n \"organisation_id\": 123,\n \"fees\": [\n \"<string>\"\n ],\n \"currency_value\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"rate\": 123\n },\n \"tags\": [\n \"<string>\"\n ],\n \"systems\": [\n \"<string>\"\n ],\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_current\": 123,\n \"price_sell\": 123,\n \"quantity\": 123,\n \"external_id\": \"<string>\",\n \"price_original\": 123,\n \"price_margin\": 123,\n \"discounts\": [\n \"<string>\"\n ],\n \"sku\": \"<string>\",\n \"department\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"variant_external_id\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"product_variant_id\": 123,\n \"product_variant\": {\n \"product_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"category\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"brand\": \"<string>\",\n \"price\": 123\n }\n }\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.{tenant}.getomneo.com/api/v3/transactions/{transaction}")
.header("Content-Type", "application/json")
.body("{\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"redemption_id\": 123,\n \"external_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"total\": 123,\n \"total_original\": 123,\n \"rounding\": 123,\n \"tender\": \"<string>\",\n \"is_void\": true,\n \"margin\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"staff_id\": \"<string>\",\n \"payments\": [\n \"<string>\"\n ],\n \"receipt_is_email\": true,\n \"receipt_ref\": \"<string>\",\n \"linked_receipt_ref\": \"<string>\",\n \"receipt_email\": \"jsmith@example.com\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"order_number\": \"<string>\",\n \"order_id\": 123,\n \"external_order_id\": \"<string>\",\n \"need_action\": true,\n \"organisation_id\": 123,\n \"fees\": [\n \"<string>\"\n ],\n \"currency_value\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"rate\": 123\n },\n \"tags\": [\n \"<string>\"\n ],\n \"systems\": [\n \"<string>\"\n ],\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_current\": 123,\n \"price_sell\": 123,\n \"quantity\": 123,\n \"external_id\": \"<string>\",\n \"price_original\": 123,\n \"price_margin\": 123,\n \"discounts\": [\n \"<string>\"\n ],\n \"sku\": \"<string>\",\n \"department\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"variant_external_id\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"product_variant_id\": 123,\n \"product_variant\": {\n \"product_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"category\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"brand\": \"<string>\",\n \"price\": 123\n }\n }\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/transactions/{transaction}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"redemption_id\": 123,\n \"external_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"total\": 123,\n \"total_original\": 123,\n \"rounding\": 123,\n \"tender\": \"<string>\",\n \"is_void\": true,\n \"margin\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"staff_id\": \"<string>\",\n \"payments\": [\n \"<string>\"\n ],\n \"receipt_is_email\": true,\n \"receipt_ref\": \"<string>\",\n \"linked_receipt_ref\": \"<string>\",\n \"receipt_email\": \"jsmith@example.com\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"order_number\": \"<string>\",\n \"order_id\": 123,\n \"external_order_id\": \"<string>\",\n \"need_action\": true,\n \"organisation_id\": 123,\n \"fees\": [\n \"<string>\"\n ],\n \"currency_value\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"rate\": 123\n },\n \"tags\": [\n \"<string>\"\n ],\n \"systems\": [\n \"<string>\"\n ],\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_current\": 123,\n \"price_sell\": 123,\n \"quantity\": 123,\n \"external_id\": \"<string>\",\n \"price_original\": 123,\n \"price_margin\": 123,\n \"discounts\": [\n \"<string>\"\n ],\n \"sku\": \"<string>\",\n \"department\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"variant_external_id\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"product_variant_id\": 123,\n \"product_variant\": {\n \"product_id\": \"<string>\",\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"category\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"brand\": \"<string>\",\n \"price\": 123\n }\n }\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"

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>"
}
{
"message": "<string>",
"errors": {}
}

Path Parameters

transaction
integer
required

The transaction ID

Body

application/json
profile_id
string | null
profile_id_handle
string | null
redemption_id
integer | null
external_id
string | null
location_id
string | null
currency
string | null
total
number
total_original
number | null
rounding
number | null
tender
string | null
is_void
boolean | null
margin
number | null
transacted_at
string
timezone
string
meta
string[] | null
staff_id
string | null
payments
string[]
receipt_is_email
boolean | null
receipt_ref
string | null
linked_receipt_ref
string | null
receipt_email
string<email> | null
type
string | null
status
string | null
order_number
string | null
order_id
integer | null
external_order_id
string | null
need_action
boolean | null
organisation_id
integer | null
fees
string[] | null
currency_value
object
tags
string[]
systems
string[]
items
object[]
Minimum array length: 1
custom_fields
object[]

Response

Return the newly created transaction.

Transaction

data
Transaction · object
required