property_helpers : Foxy hAPI

property_helpers

Description

Property helpers are links to various helpers for determining default values for resource properties along with other helpful API information.

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 all property helpers.
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

This result varies per helper and may change over time.

Countries: The response will default to active countries only. If you need all countries, add an empty get parameter like ?active=. You can also explicitly filter for active or inactive countries: ?active=false or ?active=true. You can also provide a include_regions=true filter to include all the regions with each country instead of just the has_regions property.

Example Representation

{
  "_links": {
    "curies": [
        {
            "name": "fx",
            "href": "https://api.foxycart.com/rels/{rel}",
            "templated": true
        }
    ],
    "self": {
      "href": "https://api-sandbox.foxycart.com/property_helpers",
      "title": "Property Helpers Home"
    },
    "fx:hosted_payment_gateways": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/hosted_payment_gateways",
      "title": "Hosted Payment Gateways such as PayPal, BitPay, and Dwolla."
    },
    "fx:checkout_types": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/checkout_types",
      "title": "List of valid checkout type values for the Store resource checkout_type setting."
    },
    "fx:customer_password_hash_types": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/customer_password_hash_types",
      "title": "List of valid customer password hash type values for the Store resource customer_password_hash_type setting."
    },
    "fx:default_templates": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/default_templates",
      "title": "Get default templates for the cart, checkout, receipt and email."
    },
    "fx:languages": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/languages",
      "title": "List of valid language values for the Store resource language setting."
    },
    "fx:language_strings": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/language_strings",
      "title": "List of the default language strings that can be overriden."
    },
    "fx:locale_codes": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/locale_codes",
      "title": "List of all supported locales."
    },
    "fx:payment_gateways": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/payment_gateways",
      "title": "List of supported Payment Gateways and valid entries for that resource's type setting."
    },
    "fx:shipping_methods": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods",
      "title": "The shipping carriers used when configuring live shipping rates."
    },
    "fx:shipping_address_types": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_address_types",
      "title": "List of valid address type values for the Store resource shipping_address_type setting."
    },
    "fx:countries": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/countries",
      "title": "List of valid country values for any country setting such as the Store resource store_country."
    },
    "fx:regions": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/regions",
      "title": "List of valid region values. It defaults to US states, but you can filter for other country states using ?country_code=<valid country code>"
    },
    "fx:store_versions": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/store_versions",
      "title": "Store versions available along with their changelog details."
    },
    "fx:timezones": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/timezones",
      "title": "List of valid timezones for the store resource timezone setting."
    }
  },
  "message": "Listed here are links to various helpers for determining default values for resource properties along with other helpful API information."
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers">
  <link rel="self" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/>
  <link rel="https://api.foxycart.com/rels/hosted_payment_gateways" href="https://api.foxycart.com/property_helpers/hosted_payment_gateways" title="Hosted Payment Gateways such as PayPal, BitPay, and Dwolla."/>
  <link rel="https://api.foxycart.com/rels/checkout_types" href="https://api.foxycart.com/property_helpers/checkout_types" title="List of valid checkout type values for the Store resource checkout_type setting."/>
  <link rel="https://api.foxycart.com/rels/customer_password_hash_types" href="https://api.foxycart.com/property_helpers/customer_password_hash_types" title="List of valid customer password hash type values for the Store resource customer_password_hash_type setting."/>
  <link rel="https://api.foxycart.com/rels/default_templates" href="https://api.foxycart.com/property_helpers/default_templates" title="Get default templates for the cart, checkout, receipt and email."/>
  <link rel="https://api.foxycart.com/rels/languages" href="https://api.foxycart.com/property_helpers/languages" title="List of valid language values for the Store resource language setting."/>
  <link rel="https://api.foxycart.com/rels/language_strings" href="https://api.foxycart.com/property_helpers/language_strings" title="List of the default language strings that can be overriden."/>
  <link rel="https://api.foxycart.com/rels/locale_codes" href="https://api.foxycart.com/property_helpers/locale_codes" title="List of all supported locales."/>
  <link rel="https://api.foxycart.com/rels/payment_gateways" href="https://api.foxycart.com/property_helpers/payment_gateways" title="List of supported Payment Gateways and valid entries for that resource&amp;#039;s type setting."/>
  <link rel="https://api.foxycart.com/rels/shipping_methods" href="https://api.foxycart.com/property_helpers/shipping_methods" title="The shipping carriers used when configuring live shipping rates."/>
  <link rel="https://api.foxycart.com/rels/shipping_address_types" href="https://api.foxycart.com/property_helpers/shipping_address_types" title="List of valid address type values for the Store resource shipping_address_type setting."/>
  <link rel="https://api.foxycart.com/rels/countries" href="https://api.foxycart.com/property_helpers/countries" title="List of valid country values for any country setting such as the Store resource store_country."/>
  <link rel="https://api.foxycart.com/rels/regions" href="https://api.foxycart.com/property_helpers/regions" title="List of valid region values. It defaults to US states, but you can filter for other country states using ?country_code=&amp;lt;valid country code&amp;gt;"/>
  <link rel="https://api.foxycart.com/rels/store_versions" href="https://api.foxycart.com/property_helpers/store_versions" title="Store versions available along with their changelog details."/>
  <link rel="https://api.foxycart.com/rels/timezones" href="https://api.foxycart.com/property_helpers/timezones" title="List of valid timezones for the store resource timezone setting."/>
  <message>Listed here are links to various helpers for determining default values for resource properties along with other helpful API information.</message>
</resource>

{
    "properties": {
        "message": "Listed here are links to various helpers for determining default values for resource properties along with other helpful API information."
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/hosted_payment_gateways"
            ],
            "href": "https://api.foxycart.com/property_helpers/hosted_payment_gateways"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/checkout_types"
            ],
            "href": "https://api.foxycart.com/property_helpers/checkout_types"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/customer_password_hash_types"
            ],
            "href": "https://api.foxycart.com/property_helpers/customer_password_hash_types"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/default_templates"
            ],
            "href": "https://api.foxycart.com/property_helpers/default_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/languages"
            ],
            "href": "https://api.foxycart.com/property_helpers/languages"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/language_strings"
            ],
            "href": "https://api.foxycart.com/property_helpers/language_strings"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/locale_codes"
            ],
            "href": "https://api.foxycart.com/property_helpers/locale_codes"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/payment_gateways"
            ],
            "href": "https://api.foxycart.com/property_helpers/payment_gateways"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_methods"
            ],
            "href": "https://api.foxycart.com/property_helpers/shipping_methods"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_address_types"
            ],
            "href": "https://api.foxycart.com/property_helpers/shipping_address_types"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/countries"
            ],
            "href": "https://api.foxycart.com/property_helpers/countries"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/regions"
            ],
            "href": "https://api.foxycart.com/property_helpers/regions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store_versions"
            ],
            "href": "https://api.foxycart.com/property_helpers/store_versions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/timezones"
            ],
            "href": "https://api.foxycart.com/property_helpers/timezones"
        }
    ]
}

Zoomable Resources

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