language_overrides

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Sandbox Example

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

Actions

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

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:language_overrides": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/language_override">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>
{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: language_override

Description

A language override allows you to customize an individual string output by FoxyCart. You can view all the language strings via the language_string Property Helper and use the key values there for the code value of a language override.

Sandbox Example

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

Actions

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

Properties

Property Description Type Constraints
code The code for this language string. This is the same code you will see in the FC.json.config.lang array. String Required. language_strings
gateway For the language strings specific to a payment gateway, enter the gateway key here. String Required if referencing the gateways array in language_strings
custom_value Your custom string for this language code. String Required. 800 characters or less.
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api-sandbox.foxycart.com/language_overrides/2602",
            "title": "This Language Override"
        },
        "fx:language_overrides": {
            "href": "https://api-sandbox.foxycart.com/template_sets/6/language_overrides",
            "title": "Language Overrides for this template set"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/8",
            "title": "This Store"
        },
        "fx:template_set": {
            "href": "https://api-sandbox.foxycart.com/template_sets/6",
            "title": "This Template Set"
        }
    },
    "code": "cart_caption",
    "gateway": "",
    "custom_value": "The Cart of Wonder",
    "date_created": "2015-05-21T14:46:15-0700",
    "date_modified": "2015-05-21T14:46:15-0700"
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/language_overrides/2602" rel="https://api.foxycart.com/rels/language_override">
  <link rel="self" href="https://api-sandbox.foxycart.com/language_overrides/2602" title="This Language Override"/>
  <link rel="https://api.foxycart.com/rels/language_overrides" href="https://api-sandbox.foxycart.com/template_sets/6/language_overrides" title="Language Overrides for this template set"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/8" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/template_set" href="https://api-sandbox.foxycart.com/template_sets/6" title="This Template Set"/>
  <code>cart_caption</code>
  <gateway></gateway>
  <custom_value>The Cart of Wonder</custom_value>
  <date_created>2015-05-21T14:46:15-0700</date_created>
  <date_modified>2015-05-21T14:46:15-0700</date_modified>
</resource>
{
    "class": [
        "language_override"
    ],
    "properties": {
        "code": "cart_caption",
        "gateway": "",
        "custom_value": "The Cart of Wonder",
        "date_created": "2015-05-21T14:46:15-0700",
        "date_modified": "2015-05-21T14:46:15-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/language_overrides/2602"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/language_overrides"
            ],
            "href": "https://api-sandbox.foxycart.com/template_sets/6/language_overrides"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/8"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/template_set"
            ],
            "href": "https://api-sandbox.foxycart.com/template_sets/6"
        }
    ]
}

Zoomable Resources

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