changelogs

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 changelogs
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:changelogs": [...]
  },
  "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/changelog">
  ...
  </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: changelog

Description

All changes to store resources will be logged to this table, when resources are created, updated or deleted, including their values before and after the change.

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 changelog
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
user_id User id that made the change, when initiated through the admin Integer Read only
action What action occurred to this resource String Read only. Can be "created", "deleted" or "updated"
resource Name of the resource type that was changed String Read only
resource_id ID of the resource that was changed Integer Read only
prev_values Value before the changes JSON Read only
new_values Value after the changes JSON Read only
date_created The date this resource was created. Date Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.test/changelogs/1",
            "title": "This store changes log"
        },
        "fx:user": {
            "href": "https://api.foxycart.test/users/8956",
            "title": "This User"
        },
        "fx:store": {
            "href": "https://api.foxycart.test/stores/40018",
            "title": "This Store"
        }
    },
    "store_id": 40018,
    "user_id": 8956,
    "action": "updated",
    "resource": "store",
    "resource_id": 40018,
    "prev_values": {
        "region": "BC",
        "country": "CA",
        "features": {
            "currency_conversion": true,
            "allow_transaction_editing": true,
            "show_currency_in_datafeed": true
        },
        "language": "english",
        "logo_url": "",
        "timezone": "Europe/Moscow",
        "is_active": true,
        "store_url": "http://test.test/foxy/",
        "from_email": "from_email@a.ru",
        "store_name": "haha&hehe&hihi11!:)",
        "locale_code": "en_US",
        "postal_code": "V6M 4H1",
        "smtp_config": "",
        "store_email": "test@gmail.com",
        "use_webhook": false,
        "webhook_key": "B2DJywbZ3YLBwxGXWI83NLzWFgC99mh62xar5BTWArfPkfLHf3GGQu8bV4Ez",
        "webhook_url": "https://test.test/foxy/datafeed/endpoint.php",
        "affiliate_id": 0,
        "date_created": "2016-01-28T10:40:37-0800",
        "store_domain": "store",
        "checkout_type": "default_account",
        "date_modified": "2025-03-28T07:29:08-0700",
        "use_email_dns": false,
        "send_html_email": true,
        "app_session_time": 43200,
        "store_version_uri": "https://api.foxycart.test/property_helpers/store_versions/24",
        "use_remote_domain": false,
        "features_multiship": true,
        "first_payment_date": null,
        "single_sign_on_url": "https://test.test/foxy/sso/index.php",
        "use_single_sign_on": true,
        "is_maintenance_mode": false,
        "use_cart_validation": false,
        "bcc_on_receipt_email": true,
        "hide_currency_symbol": false,
        "receipt_continue_url": "",
        "shipping_address_type": "residential",
        "hide_decimal_characters": false,
        "custom_display_id_config": {
            "start": "1",
            "length": "1",
            "prefix": "bla",
            "suffix": "qwe",
            "enabled": true
        },
        "customer_password_hash_type": "argon2id",
        "unified_order_entry_password": "",
        "customer_password_hash_config": "16",
        "require_signed_shipping_rates": true,
        "products_require_expires_property": false,
        "use_international_currency_symbol": false
    },
    "new_values": {
        "region": "BC",
        "country": "CA",
        "features": {
            "currency_conversion": true,
            "allow_transaction_editing": true,
            "show_currency_in_datafeed": true
        },
        "language": "english",
        "logo_url": "",
        "timezone": "Europe/Moscow",
        "is_active": true,
        "store_url": "http://test.test/foxy/",
        "from_email": "from_email@a.ru",
        "store_name": "416bc80e-6c2b-446e-9615-6923e15e116f",
        "locale_code": "en_US",
        "postal_code": "V6M 4H1",
        "smtp_config": "",
        "store_email": "test@gmail.com",
        "use_webhook": false,
        "webhook_key": "B2DJywbZ3YLBwxGXWI83NLzWFgC99mh62xar5BTWArfPkfLHf3GGQu8bV4Ez",
        "webhook_url": "https://test.test/foxy/datafeed/endpoint.php",
        "affiliate_id": 0,
        "date_created": "2016-01-28T10:40:37-0800",
        "store_domain": "store",
        "checkout_type": "default_account",
        "date_modified": "2025-04-01T11:06:11-0700",
        "use_email_dns": false,
        "send_html_email": true,
        "app_session_time": 43200,
        "store_version_uri": "https://api.foxycart.test/property_helpers/store_versions/24",
        "use_remote_domain": false,
        "features_multiship": true,
        "first_payment_date": null,
        "single_sign_on_url": "https://test.test/foxy/sso/index.php",
        "use_single_sign_on": true,
        "is_maintenance_mode": false,
        "use_cart_validation": false,
        "bcc_on_receipt_email": true,
        "hide_currency_symbol": false,
        "receipt_continue_url": "",
        "shipping_address_type": "residential",
        "hide_decimal_characters": false,
        "custom_display_id_config": {
            "start": "1",
            "length": "1",
            "prefix": "bla",
            "suffix": "qwe",
            "enabled": true
        },
        "customer_password_hash_type": "argon2id",
        "unified_order_entry_password": "",
        "customer_password_hash_config": "16",
        "require_signed_shipping_rates": true,
        "products_require_expires_property": false,
        "use_international_currency_symbol": false
    },
    "created_at": "2025-04-01T11:06:11-0700"
}


    

    

        

    









Zoomable Resources



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