locale_codes

Description

This property helper lets you know which locale codes are supported for the Store resource's locale_code property.

The values JSON object are in a name / value pair combination per locale of locale_code and description strings.

Sandbox Example

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

Actions

GET
View a locale_codes
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 objects with the locale codes supported. The key values are the values you use for the Store resource's locale_code property. 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/locale_codes",
            "title": "List of all supported locales."
        },
        "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 locale_code field. The values are listed in the format value => description.",
    "values": {
        "aa_DJ": "Afar locale for Djibouti (CaduLaaqo Dialects) (Currency: DJF:$)",
        "aa_ER": "Afar locale for Eritrea (CaduLaaqo Dialects) (Currency: ERN:$)",
        "aa_ET": "Afar locale for Ethiopia (CaduCarra Dialects) (Currency: ETB:$)",
        "af_ZA": "Afrikaans locale for South Africa (Currency: ZAR:R)",
        ...
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/locale_codes">
  <link rel="self" href="https://api.foxycart.com/property_helpers/locale_codes" title="List of all supported locales."/>
  <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 locale_code field. The values are listed in the format value =&amp;gt; description.</message>
  <values>
    <aa_DJ>Afar locale for Djibouti (CaduLaaqo Dialects) (Currency: DJF:$)</aa_DJ>
    <aa_ER>Afar locale for Eritrea (CaduLaaqo Dialects) (Currency: ERN:$)</aa_ER>
    <aa_ET>Afar locale for Ethiopia (CaduCarra Dialects) (Currency: ETB:$)</aa_ET>
    <af_ZA>Afrikaans locale for South Africa (Currency: ZAR:R)</af_ZA>
    ...
  </values>
</resource>

{
    "properties": {
        "message": "The values listed here are the correct values for the Store locale_code field. The values are listed in the format value => description.",
        "values": {
            "aa_DJ": "Afar locale for Djibouti (CaduLaaqo Dialects) (Currency: DJF:$)",
            "aa_ER": "Afar locale for Eritrea (CaduLaaqo Dialects) (Currency: ERN:$)",
            "aa_ET": "Afar locale for Ethiopia (CaduCarra Dialects) (Currency: ETB:$)",
            "af_ZA": "Afrikaans locale for South Africa (Currency: ZAR:R)",
            ...
        }
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers/locale_codes"
        },
        {
            "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.