checkout_template

Collection: checkout_templates

The Checkout Template contains the Twig content used to display the checkout page for your store. To use the default responsive theme, leave the content property empty. If you want to set your own template content, configure a content_url and then POST to the cache link relationship to cache your store's checkout template. This will run your content through our caching system which will rewrite all the JavaScript, CSS, and HTML to cache images securely on our servers.

Required Scopes

Full store_full_access
Read templates_read
Write templates_write

Actions

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

Properties (5)

description String

The description of your checkout template. Required. 100 characters or less. Defaults to Checkout Template.

content String

The content of your checkout template. Leave blank to use the default responsive template. This shouldn't be set directly unless all of your image references are already over https. If they are not, set the content_url to point to your template content online and then POST to the cache link relationship.

content_url String

The URL of your checkout template hosted on your own server online and publicly available for our server to cache. 300 characters or less.

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 (5)

self This Template
fx:store GET PATCH PUT DELETE This Store
fx:template_sets GET POST Template Sets using this template
fx:cache POST here to cache your template using the content_url
fx:encode POST here to encode a body of html for use with our HMAC cart encryption.
https://api.foxycart.com/checkout_templates/{id}
Available via fx:checkout_template on template_set

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/checkout_templates/123",
      "title": "This Template"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:template_sets": {
      "href": "https://api.foxycart.com/checkout_templates/123/template_sets",
      "title": "Template Sets using this template"
    },
    "fx:cache": {
      "href": "https://api.foxycart.com/checkout_templates/123/cache",
      "title": "POST here to cache your template using the content_url"
    },
    "fx:encode": {
      "href": "https://api.foxycart.com/encode",
      "title": "POST here to encode a body of html for use with our HMAC cart encryption."
    }
  },
  "description": "Checkout Template",
  "content": "",
  "content_url": "",
  "date_created": "2012-08-10T11:58:54-0700",
  "date_modified": "2012-08-10T11:58:54-0700"
}