Skip to main content

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.

{
   "data":[
      {
         "id":3,
         "external_id":"100491239A",
         "name":"Demo Product",
         "transaction_id":3,
         "product_id":479,
         "product_variant_id":1050,
         "sku":"1023123213",
         "variant_external_id":"EXT103313",
         "is_void":false,
         "quantity":1,
         "price_current":99.99,
         "price_sell":99.99,
         "price_original":null,
         "price_margin":null,
         "price_tax":null,
         "discounts":null,
         "product_images":[
            {
               "url":"/example.jpg":0
            },
            {
               "url":"/example2.jpg",
               "sort_order":1
            },
            {
               "url":"example2.jpg",
               "sort_order":2
            }
         ],
         "created_at":"2020-05-27 06:21:13",
         "updated_at":"2020-05-27 06:21:13"
      }
   ],
   "links":{
      "first":"http://demo_site/2/items?page.number=1",
      "last":"http://demo_site/3/items?page.number=1",
      "prev":null,
      "next":null
   },
   "meta":{
      "current_page":1,
      "from":1,
      "last_page":1,
      "path":"http://demo_site.getomneo.io/api/v3/transactions/3/items",
      "per_page":15,
      "to":1,
      "total":1
   }
}

​
What are transaction items?

Transaction items are attached to a transaction and contain pricing information that pairs with the accompanying transaction. Additional items can be added to an existing transaction by using the Add Transaction endpoint, or directly when creating the transaction with Add Transaction.

​
Transaction item properties

AttributeDescription
id INTEGER READ-ONLYThe unique Omneo identifier of the transaction item
external_id STRINGThe foreign id of the transaction item in an external system
name STRINGThe name of the item
transaction_id INTEGERThe transaction_id this transaction item is attached to.
product_id INTEGERThe id of the transaction item product
product_variant_id INTEGERThe variant id of the transaction item product
sku STRINGThe sku of the transaction item product
variant_external_id STRINGThe external variant id of the transaction item product. This is usually the id as it is in the originating external system.
is_void BOOLEANDenotes whether this item has been voided on this transaction.
quantity INTEGERThe quantity sold on this transaction
price_current FLOATThe current available price of the item (including tax)
price_sell FLOATActual price paid for the item, after all discounts (including tax). This is the refundable amount for the item.
price_original FLOATThe original price, RRP, base or standard price of the item.
price_margin FLOATA $ value margin made on the sale for this item
price_tax FLOATA $ value tax charged for this item
discounts ARRAYAn array of discounts applied to this item
product_images ARRAYAn array of product images attached to this item
created_at READ-ONLY DATE-TIMEThe UTC date & time the Transaction Item record was created in ISO 8601 format.
updated_at READ-ONLY DATE-TIMEThe UTC date & time the Transaction Item record was last updated in ISO 8601 format.