timezones

Description

This property helper gives you the valid entries for the Store resource's timezone property. In order to support XML format, the timezones are organized in an array (timezones have slashes which aren't valid in xml nodes) with each entry having a timezone and description proeprties.

The values JSON object has a timezone array with each entry containing the following properties:

  • timezone: The value you can use for the Store's timezone property.
  • description: The full description of this timezone.

Sandbox Example

You can interact with this resource and run actions against the sandbox API via our HAL Brower.

Actions

GET
View a timezones
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
message A small, human readable explanation of this property helper. String Read only
values JSON object with an array of timezones. JSON 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/timezones",
            "title": "List of valid timezones for the store resource timezone setting."
        },
        "fx:property_helpers": {
            "href": "https://api.foxycart.com/property_helpers",
            "title": "Property Helpers Home"
        }
    },
    "message": "The values listed here are the correct values for the Store timezone field. The values are listed in a values => timezone => timezone format.",
    "values": {
        "timezone": [
            {
                "timezone": "Kwajalein",
                "description": "(GMT-12:00) International Date Line West"
            },
            {
                "timezone": "Pacific/Midway",
                "description": "(GMT-11:00) Midway Island"
            },
            ...
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/regions">
  <link rel="self" 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/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/property_helpers" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/>
  <message>The values listed here are the correct values for the Store store_state field for the given country code. The values are listed in the format value =&amp;gt; description. If no values are specified, any store_state value can be used for this country code.</message>
  <values>
    <AL>
      <default>Alabama</default>
      <code>AL</code>
      <alternate_values/>
      <boost></boost>
      <active>true</active>
    </AL>
    <AK>
      <default>Alaska</default>
      <code>AK</code>
      <alternate_values/>
      <boost></boost>
      <active>true</active>
    </AK>
    ...
  </values>
</resource>

{
    "properties": {
        "message": "The values listed here are the correct values for the Store timezone field. The values are listed in a values => timezone => timezone format.",
        "values": {
            "timezone": [
                {
                    "timezone": "Kwajalein",
                    "description": "(GMT-12:00) International Date Line West"
                },
                {
                    "timezone": "Pacific/Midway",
                    "description": "(GMT-11:00) Midway Island"
                },
                ...
            ]
        }
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers/timezones"
        },
        {
            "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.