error_entries

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.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET
View a list of error_entries
POST
Add an error_entries
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:error_entries": [...]
  },
  "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/error_entry">
  ...
  </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: error_entry

Description

An error entry is a logged error for your store. Many different interactions can add error entries such as a customer attempting to checkout with a failed payment method or failed response from our webhook system. These entries can be hidden from the admin using the hide_error property.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET
View a error_entry
PATCH
Update a error_entry (send only the properties you want to modify)
PUT
Replace a error_entry (send the entire representation)
DELETE
Delete a error_entry
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
url The Foxy page where the error took place. String Read only
error_message The error message explaining what happened. String Read only
user_agent The user agent string collected at the time of the error. String Read only
referrer The browser referrer value at the time of the error. String Read only
ip_address The IP Address of the user collected at the time of the error. String Read only
ip_country The country of the user based on the IP Address at the time of the error. String Read only
post_values All the POST data sent to the url at the time of the error. Note: secure card holder data such as the card number, csc, or password will not be included in this data. String Read only
get_values All the GET data sent to the url at the time of the error. Note: secure card holder data such as the card number, csc, or password will not be included in this data. String Read only
hide_error Set this to false to hide this error entry from the Foxy administrative interface. This may be a helpful way to manage and acknowledge errors for your store. Boolean true or false, 1 or 0
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api-sandbox.foxycart.com/error_entries/63066",
            "title": "This Error Entry"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/8",
            "title": "This Store"
        }
    },
    "url": "https://api-sandbox.foxycart.com/api_rest.php",
    "error_message": "DataFeed Failed: (2) 2012-08-10 12:12:49 No data returned for  [0]\n malformed",
    "user_agent": "curl/7.21.3 (i386-pc-win32) libcurl/7.21.3 OpenSSL/0.9.8q zlib/1.2.5",
    "referer": "",
    "ip_address": "10.1.249.103",
    "ip_country": "",
    "post_values": "",
    "get_values": "",
    "hide_error": false,
    "date_created": "2012-08-10T12:12:49-0700",
    "date_modified": null
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/error_entries/63066" rel="https://api.foxycart.com/rels/error_entry">
  <link rel="self" href="https://api-sandbox.foxycart.com/error_entries/63066" title="This Error Entry"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/8" title="This Store"/>
  <url>https://api-sandbox.foxycart.com/api_rest.php</url>
  <error_message>DataFeed Failed: (2) 2012-08-10 12:12:49 No data returned for  [0]
&amp;lt;url&amp;gt; malformed</error_message>
  <user_agent>curl/7.21.3 (i386-pc-win32) libcurl/7.21.3 OpenSSL/0.9.8q zlib/1.2.5</user_agent>
  <referer></referer>
  <ip_address>10.1.249.103</ip_address>
  <ip_country></ip_country>
  <post_values></post_values>
  <get_values></get_values>
  <hide_error>false</hide_error>
  <date_created>2012-08-10T12:12:49-0700</date_created>
  <date_modified></date_modified>
</resource>

{
    "class": [
        "error_entry"
    ],
    "properties": {
        "url": "https://api-sandbox.foxycart.com/api_rest.php",
        "error_message": "DataFeed Failed: (2) 2012-08-10 12:12:49 No data returned for  [0]\n malformed",
        "user_agent": "curl/7.21.3 (i386-pc-win32) libcurl/7.21.3 OpenSSL/0.9.8q zlib/1.2.5",
        "referer": "",
        "ip_address": "10.1.249.103",
        "ip_country": "",
        "post_values": "",
        "get_values": "",
        "hide_error": false,
        "date_created": "2012-08-10T12:12:49-0700",
        "date_modified": null
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/error_entries/63066"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8"
        }
    ]
}

Zoomable Resources

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