template_configs

Resource: template_config

This link relationship returns a collection of template configs. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read templates_read
Write templates_write

Collection Resource

template_config

Actions

GET View a list of template_configs
POST Create a new template config
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:template_configs[] — array of template_config resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/template_configs
Available via fx:template_configs on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/template_configs",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/template_configs?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/template_configs?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/template_configs?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/template_configs?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:template_configs": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/template_configs/456",
            "title": "This Template Config"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:template_sets": {
            "href": "https://api.foxycart.com/template_configs/123/template_sets",
            "title": "Template Sets using this template config"
          }
        },
        "description": "Template Config",
        "json": "{\"cart_type\":\"default\",\"checkout_type\":\"default_account\",\"csc_requirements\":\"all_cards\",\"tos_checkbox_settings\":{\"usage\":\"none\",\"initial_state\":\"unchecked\",\"is_hidden\":false,\"url\":\"\"},\"eu_secure_data_transfer_consent\":{\"usage\":\"required\"},\"newsletter_subscribe\":{\"usage\":\"none\"},\"analytics_config\":{\"usage\":\"none\",\"google_analytics\":{\"usage\":\"none\",\"account_id\":\"\",\"include_on_site\":false},\"google_tag\":{\"usage\":\"none\",\"account_id\":\"\",\"send_to\":\"\"}},\"colors\":{\"usage\":\"none\",\"primary\":\"4D4D4D\",\"secondary\":\"FFFFFF\",\"tertiary\":\"FFFFFF\"},\"supported_payment_cards\":[\"visa\",\"mastercard\",\"discover\",\"amex\"],\"custom_checkout_field_requirements\":{\"cart_controls\":\"enabled\",\"coupon_entry\":\"enabled\",\"billing_first_name\":\"required\",\"billing_last_name\":\"required\",\"billing_company\":\"optional\",\"billing_tax_id\":\"hidden\",\"billing_phone\":\"optional\",\"billing_address1\":\"required\",\"billing_address2\":\"optional\",\"billing_city\":\"required\",\"billing_region\":\"default\",\"billing_postal_code\":\"required\",\"billing_country\":\"required\"},\"foxycomplete\":{\"usage\":\"required\",\"show_combobox\":true,\"show_flags\":true},\"custom_script_values\":{\"header\":\"\",\"footer\":\"\",\"checkout_fields\":\"\",\"multiship_checkout_fields\":\"\"},\"http_receipt\":false,\"custom_config\":{},\"debug\":{\"usage\":\"none\"},\"location_filtering\":{\"usage\":\"none\",\"shipping_filter_type\":\"blacklist\",\"billing_filter_type\":\"blacklist\",\"shipping_filter_values\":{},\"billing_filter_values\":{}},\"postal_code_lookup\":{\"usage\":\"enabled\"}}",
        "date_created": "2012-08-10T11:58:54-0700",
        "date_modified": "2012-08-10T11:58:54-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}