Skip to main content
POST
/
v3
/
transactions
/
queue
/
create
Queue Transaction Create Request
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/transactions/queue/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "total": 123,
  "transacted_at": "<string>",
  "timezone": "<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
      }
    }
  ],
  "profile_id": "<string>",
  "profile_id_handle": "<string>",
  "redemption_id": 123,
  "external_id": "<string>",
  "location_id": "<string>",
  "currency": "<string>",
  "total_original": 123,
  "rounding": 123,
  "tender": "<string>",
  "is_void": true,
  "margin": 123,
  "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>"
  ],
  "custom_fields": [
    {
      "namespace": "<string>",
      "handle": "<string>",
      "value": "<string>"
    }
  ]
}
'
import requests

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

payload = {
    "total": 123,
    "transacted_at": "<string>",
    "timezone": "<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
            }
        }
    ],
    "profile_id": "<string>",
    "profile_id_handle": "<string>",
    "redemption_id": 123,
    "external_id": "<string>",
    "location_id": "<string>",
    "currency": "<string>",
    "total_original": 123,
    "rounding": 123,
    "tender": "<string>",
    "is_void": True,
    "margin": 123,
    "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>"],
    "custom_fields": [
        {
            "namespace": "<string>",
            "handle": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    total: 123,
    transacted_at: '<string>',
    timezone: '<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
        }
      }
    ],
    profile_id: '<string>',
    profile_id_handle: '<string>',
    redemption_id: 123,
    external_id: '<string>',
    location_id: '<string>',
    currency: '<string>',
    total_original: 123,
    rounding: 123,
    tender: '<string>',
    is_void: true,
    margin: 123,
    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>'],
    custom_fields: [{namespace: '<string>', handle: '<string>', value: '<string>'}]
  })
};

fetch('https://api.{tenant}.getomneo.com/api/v3/transactions/queue/create', 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/queue/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'total' => 123,
    'transacted_at' => '<string>',
    'timezone' => '<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
                ]
        ]
    ],
    'profile_id' => '<string>',
    'profile_id_handle' => '<string>',
    'redemption_id' => 123,
    'external_id' => '<string>',
    'location_id' => '<string>',
    'currency' => '<string>',
    'total_original' => 123,
    'rounding' => 123,
    'tender' => '<string>',
    'is_void' => true,
    'margin' => 123,
    '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>'
    ],
    '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/queue/create"

	payload := strings.NewReader("{\n  \"total\": 123,\n  \"transacted_at\": \"<string>\",\n  \"timezone\": \"<string>\",\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  \"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_original\": 123,\n  \"rounding\": 123,\n  \"tender\": \"<string>\",\n  \"is_void\": true,\n  \"margin\": 123,\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  \"custom_fields\": [\n    {\n      \"namespace\": \"<string>\",\n      \"handle\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.{tenant}.getomneo.com/api/v3/transactions/queue/create")
  .header("Content-Type", "application/json")
  .body("{\n  \"total\": 123,\n  \"transacted_at\": \"<string>\",\n  \"timezone\": \"<string>\",\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  \"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_original\": 123,\n  \"rounding\": 123,\n  \"tender\": \"<string>\",\n  \"is_void\": true,\n  \"margin\": 123,\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  \"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/queue/create")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"total\": 123,\n  \"transacted_at\": \"<string>\",\n  \"timezone\": \"<string>\",\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  \"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_original\": 123,\n  \"rounding\": 123,\n  \"tender\": \"<string>\",\n  \"is_void\": true,\n  \"margin\": 123,\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  \"custom_fields\": [\n    {\n      \"namespace\": \"<string>\",\n      \"handle\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>",
  "errors": {}
}

Body

application/json
total
number
required
transacted_at
string
required
timezone
string
required
items
object[]
required
Minimum array length: 1
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_original
number | null
rounding
number | null
tender
string | null
is_void
boolean | null
margin
number | null
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[]
custom_fields
object[]

Response

data
string
required
Allowed value: "OK"