transaction_log_detail

Collection: transaction_log_details

Details of an individual transaction log change. The log JSON contains the following fields:

  • rel: Similar to a link relationship, this value should let you know which resource was modified (e.g., item or transaction).
  • id: The internal identifier for the resource that was modified.
  • old_values: JSON object of old values prior to the change.
  • new_values: JSON object of new values after this change.

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Actions

GET View a transaction log detail
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (3)

request_type String · Read-only

A text representation of the type of request this log entry is for such as item_edit.

reference String · Read-only

A reference id of some kind to help describe which resource this log entry refers to.

log String · Read-only

The details of the changes for this log in JSON format.

Link Relations (3)

self This Transaction Log Detail
fx:store GET PATCH PUT DELETE This Store
fx:transaction_log GET This Transaction Log
https://api.foxycart.com/transaction_log_details/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/transaction_log_details/123",
      "title": "This Transaction Log Detail"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:transaction_log": {
      "href": "https://api.foxycart.com/transaction_logs/999",
      "title": "This Transaction Log"
    }
  },
  "request_type": "item_edit",
  "reference": "foo: 5638510",
  "log": "{\"rel\":\"item\",\"id\":\"5638510\",\"old_values\":{\"options\":{\"4813185\":{\"price_mod\":\"10.0000000000\"}}},\"new_values\":{\"options\":{\"4813185\":{\"name\":\"Test\",\"value\":\"test\",\"price_mod\":0}}}}"
}