error_entry

Collection: error_entries

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 a failed response from the webhook system. These entries can be hidden from the admin using the hide_error property.

Required Scopes

Full store_full_access
Read reporting_read
Write reporting_write

Actions

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

Properties (11)

url String · Read-only

The Foxy page where the error took place.

error_message String · Read-only

The error message explaining what happened.

user_agent String · Read-only

The user agent string collected at the time of the error.

referrer String · Read-only

The browser referrer value at the time of the error.

ip_address String · Read-only

The IP Address of the user collected at the time of the error.

ip_country String · Read-only

The country of the user based on the IP Address at the time of the error.

post_values String · Read-only

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.

get_values String · Read-only

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.

hide_error Boolean

Set this to true to hide this error entry from the Foxy administrative interface. This may be a helpful way to manage and acknowledge errors for your store.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (6)

self This Error Entry
fx:store GET PATCH PUT DELETE This Store
fx:customer GET PATCH PUT DELETE The customer associated with this error.

Only present when the error entry has an associated customer.

fx:transaction GET PATCH PUT POST The transaction associated with this error.

Only present when the error entry has an associated completed transaction.

fx:cart GET PATCH PUT POST DELETE The cart associated with this error.

Only present when the error entry has an associated incomplete transaction (cart).

fx:subscription GET PATCH PUT The subscription associated with this error.

Only present when the error entry has an associated subscription.

https://api.foxycart.com/error_entries/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/error_entries/123",
      "title": "This Error Entry"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "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<url> 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
}