transaction_log_details

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Actions

GET
View a list of transaction_log_details
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:transaction_log_details": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/transaction_log_detail">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: transaction_log_detail

Description

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. Exmaple 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.

Actions

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

Properties

Property Description Type Constraints
request_type A text representation of the type of request this log entry is for such as item_edit String Read only
reference A reference id of some kind to help describe which resource this log entry refers to. String Read only
log The details of the changes for this log in JSON format. JSON Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.com/transaction_log_details/183",
            "title": "This Transaction Log Detail"
        },
        "fx:store": {
            "href": "https://api.foxycart.com/stores/66",
            "title": "This Store"
        },
        "fx:transaction_log": {
            "href": "https://api.foxycart.com/transaction_logs/120",
            "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}}}}"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/transaction_log_details/183" rel="https://api.foxycart.com/rels/transaction_log_detail">
  <link rel="self" href="https://api.foxycart.com/transaction_log_details/183" title="This Transaction Log Detail"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/66" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/transaction_log" href="https://api.foxycart.com/transaction_logs/120" title="This Transaction Log"/>
  <request_type>item_edit</request_type>
  <reference>foo: 5638510</reference>
  <log>{&amp;quot;rel&amp;quot;:&amp;quot;item&amp;quot;,&amp;quot;id&amp;quot;:&amp;quot;5638510&amp;quot;,&amp;quot;old_values&amp;quot;:{&amp;quot;options&amp;quot;:{&amp;quot;4813185&amp;quot;:{&amp;quot;price_mod&amp;quot;:&amp;quot;10.0000000000&amp;quot;}}},&amp;quot;new_values&amp;quot;:{&amp;quot;options&amp;quot;:{&amp;quot;4813185&amp;quot;:{&amp;quot;name&amp;quot;:&amp;quot;Test&amp;quot;,&amp;quot;value&amp;quot;:&amp;quot;test&amp;quot;,&amp;quot;price_mod&amp;quot;:0}}}}</log>
</resource>

{
    "class": [
        "transaction_log_detail"
    ],
    "properties": {
        "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}}}}"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/transaction_log_details/183"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api.foxycart.com/stores/66"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transaction_log"
            ],
            "href": "https://api.foxycart.com/transaction_logs/120"
        }
    ],
    "actions": []
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.