Skip to main content
POST
/
v3
/
transactions
/
queue
Queue Transaction
curl --request POST \
  --url http://localhost/api/v3/transactions/queue \
  --header 'Content-Type: application/json' \
  --data '
{
  "total": 123,
  "transacted_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "id": 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",
  "need_action": true,
  "tags": [
    "<string>"
  ],
  "systems": [
    "<string>"
  ],
  "items": [
    {
      "name": "<string>",
      "price_current": 123,
      "price_sell": 123,
      "quantity": 123,
      "id": "<string>",
      "external_id": "<string>",
      "price_original": 123,
      "price_margin": 123,
      "discounts": [
        "<string>"
      ],
      "sku": "<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
      }
    }
  ]
}
'
{
  "data": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

​
What happens when a transaction is queued?

The main difference between this endpoint and Add Transaction is queuing a transaction adds the transaction request to a batch processing queue. The response time for this request is much faster than an Add Transaction, as the job is submitted instantly. The payload required for this endpoint is identical to the Add Transaction endpoint. In addition to the above, this endpoint includes the same functionality as Create or Update a Transaction, where an existing transaction is first searched by external_id and then id which will update the transaction if found. If no existing transaction is found, the transaction is created instead.
Queued transactions may not be created instantlyThe processing time of transactions submitted to the queue is subject to the other jobs within the queue. The response will contain no data relating to the transaction. A transaction.created or transaction.updated event will be triggered as each transaction is processed. Developers can use this to retrieve data relating to the submitted transaction.

​
When to use Queue Transaction

Queueing is primarily used for batch importing transactions. The Queue endpoint allows developers to submit high volumes of transactions for processing on a batch queue. This is usually done by the developer by looping through transactions on the external system, and sending them to the Queue Transaction endpoint.

​
When not to use Queue Transaction

If response data is required after submitting the request to this endpoint. Queue Transaction will return a 200 response ‘OK’ with every successful submission. This will not contain any information about the submitted transaction. If response data is required for population on a website or internal system, use the Add Transaction endpoint instead If transactions need to be created immediately, this endpoint is not suitable. All transactions submitted via this endpoint are subject to the other jobs on the queue. Because of this, Omneo cannot guarantee the time of creation.

Body

application/json
​
total
number
required
​
transacted_at
string<date-time>
required
​
timezone
string
required
​
id
integer | null
​
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
​
need_action
boolean | null
​
tags
string[]
​
systems
string[]
​
items
object[] | null

Response

​
data
string
required
Allowed value: "OK"