Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Metadata overrides

Get metadata overrides for the specified autocomplete ID and

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: metadata_overrides(r).

optionally query via field name and/or active.

get/v1/metadata_overrides

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90
field_namestring

Field name to filter metadata override configurations by.

Example:price

Response

OK

total_countinteger required

Total number of metadata override configurations.

Example response

{
  "metadata_overrides": [
    {
      "rules": [
        {
          "start_time": "2024-03-06T16:05:19",
          "end_time": "2024-03-07T16:05:19",
          "replaced_field_name": "price",
          "replaced_field_path_in_metadata": "data.sale_price"
        }
      ]
    }
  ]
}