language_override

Collection: language_overrides

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.

Required Scopes

Full store_full_access

Read templates_read

Write templates_write

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 (5)

code String

The code for this language string. This is the same code you will see in the FC.json.config.lang array. Required.

gateway String

For the language strings specific to a payment gateway, enter the gateway key here. Required if referencing the gateways array in language_strings.

custom_value String

Your custom string for this language code. Required. 800 characters or less.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (4)

self This Language Override

fx:language_overrides GET POST Language Overrides for this template set

fx:store GET PATCH PUT DELETE This Store

fx:template_set GET PATCH PUT DELETE This Template Set

https://api.foxycart.com/language_overrides/{id}

Example Representation

Show _links

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/language_overrides/123",
      "title": "This Language Override"
    },
    "fx:language_overrides": {
      "href": "https://api.foxycart.com/template_sets/111/language_overrides",
      "title": "Language Overrides for this template set"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:template_set": {
      "href": "https://api.foxycart.com/template_sets/111",
      "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"
}