store_versions

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.

To fitler the list to only the one version you're interested in, include a store_version_uri value as a get parameter and only the corresponding version will be returned.

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

Description

With every significant change to the FoxyCart system, we release a new version of the cart and checkout interface, complete with new features and bug fixes. In order to prevent new changes from breaking old stores, we version those changes.

If you have a tight integration with FoxyCart, you can use this resource to create a drop down box for your store admin interface, complete with the full FoxyCart changelog. You can pass in a store_domain as a URL parameter and it will dynamically include that domain in the resulting include files.

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

Properties

Property Description Type Constraints
version Human readable store version string. String Read only
changelog_blog_url The full URL of the blog post describing the new release. URL Read only
changelog_url The full URL of the changelog. URL Read only
changelog_content Full content of the changelog as HTML String Read only
cart_types A JSON object for various cart types supported by this version. Examples include colorbox with links to the JavaScript library, FoxyCart JavaScript files, and FoxyCart CSS files. JSON Read only
version_date The date this version was publicly released. Date Read only
is_visible If this version is currently visible in the FoxyCart admin. At times, FoxyCart may launch a private beta of the latest version. Boolean Read only
is_beta If this version is currently considered a beta release. Boolean Read only
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.foxycart.com/property_helpers/store_versions/21",
          "title": "This Store Version"
        },
        "fx:store_versions": {
          "href": "https://api.foxycart.com/property_helpers/store_versions",
          "title": "All Store Versions"
        },
        "fx:property_helpers": {
          "href": "https://api.foxycart.com/property_helpers/",
          "title": "Property Helpers Home Page"
        }
    },
    {
      "version": "0.7.2",
      "changelog_blog_url": "https://www.foxycart.com/blog/0.7.2",
      "changelog_url": "https://admin.foxycart.com/v/0.7.2/changelog.html",
      "changelog_content": "... html ...",
      "cart_types": {
        "colorbox": {
          "javascript_library": {
            "name": "JQuery",
            "version": "1.6.4",
            "url": "//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"
          },
          "javascript": [
            "//cdn.foxycart.com//foxycart.colorbox.js"
          ],
          "css": [
            "//cdn.foxycart.com/static/scripts/colorbox/1.3.18/style1_fc/colorbox.css?ver=1"
          ]
        },
        "none": {
          "javascript_library": {
            "name": "JQuery",
            "version": "1.6.4",
            "url": "//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"
          },
          "javascript": [
            "//cdn.foxycart.com//foxycart.js"
          ],
          "css": []
        }
      },
      "version_date": "2012-01-13T12:05:06-0800",
      "is_visible": 1,
      "is_beta": 0,
      "date_created": "2012-01-13T12:05:06-0800",
      "date_modified": "2012-01-13T12:05:06-0800"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/store_versions/21" rel="https://api.foxycart.com/rels/store_version">
  <link rel="self" href="https://api.foxycart.com/property_helpers/store_versions/21" title="This Store Version"/>
  <link rel="https://api.foxycart.com/rels/store_versions" href="https://api.foxycart.com/property_helpers/store_versions" title="All Store Versions"/>
  <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api.foxycart.com/property_helpers/" title="Property Helpers Home Page"/>
  <version>0.7.2</version>
  <changelog_blog_url>https://www.foxycart.com/blog/0.7.2</changelog_blog_url>
  <changelog_url>https://admin.foxycart.com/v/0.7.2/changelog.html</changelog_url>
  <changelog_content>... HTML ...</changelog_content>
  <cart_types>
    <colorbox>
      <javascript_library>
        <name>JQuery</name>
        <version>1.6.4</version>
        <url>//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js</url>
      </javascript_library>
      <javascript>//cdn.foxycart.com//foxycart.colorbox.js</javascript>
      <css>//cdn.foxycart.com/static/scripts/colorbox/1.3.18/style1_fc/colorbox.css?ver=1</css>
    </colorbox>
    <none>
      <javascript_library>
        <name>JQuery</name>
        <version>1.6.4</version>
        <url>//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js</url>
      </javascript_library>
      <javascript>//cdn.foxycart.com//foxycart.js</javascript>
      <css/>
    </none>
  </cart_types>
  <version_date>2011-05-07T14:15:43-0700</version_date>
  <is_visible>true</is_visible>
  <is_beta>false</is_beta>
  <date_created>2011-05-07T14:15:43-0700</date_created>
  <date_modified>2011-05-07T14:15:43-0700</date_modified>
</resource>

{
    "class": [
        "store_version"
    ],
    "properties": {
        "version": "0.7.2",
        "changelog_blog_url": "https://www.foxycart.com/blog/0.7.2",
        "changelog_url": "https://admin.foxycart.com/v/0.7.2/changelog.html",
        "changelog_content": "... HTML ...",
        "cart_types": {
            "colorbox": {
              "javascript_library": {
                "name": "JQuery",
                "version": "1.6.4",
                "url": "//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"
              },
              "javascript": [
                "//cdn.foxycart.com//foxycart.colorbox.js"
              ],
              "css": [
                "//cdn.foxycart.com/static/scripts/colorbox/1.3.18/style1_fc/colorbox.css?ver=1"
              ]
            },
            "none": {
              "javascript_library": {
                "name": "JQuery",
                "version": "1.6.4",
                "url": "//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"
              },
              "javascript": [
                "//cdn.foxycart.com//foxycart.js"
              ],
              "css": []
            }
        },
        "version_date": "2012-01-13T12:05:06-0800",
        "is_visible": 1,
        "is_beta": 0,
        "date_created": "2012-01-13T12:05:06-0800",
        "date_modified": "2012-01-13T12:05:06-0800"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers/store_versions/21"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store_versions"
            ],
            "href": "https://api.foxycart.com/property_helpers/store_versions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/property_helpers"
            ],
            "href": "https://api.foxycart.com/property_helpers/"
        }
    ]
}

Zoomable Resources

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