Templates

PUT

An import of templates for response object customization, used with the query parameter ‘templateId’. Importing templates with PUT will remove all existing templates not in the import!

PUT https://{cluster-id}.elevate-api.cloud/api/admin/v3/import/templates

Request

Request header parameters

Name	Description	Example
`Api-Key`*	API key supplied during onboarding.	`123456789..`
`Content-Encoding`	Defines which encoding was used to compress the data.	`gzip`
`Content-Type`	application/json	`application/json`

Request query parameters

Name	Description	Example
`force`	If false, the import will fail if an existing template was removed as a result of this import. Redo the import with this flag set to true if this is intended.
`name`	A name to identify the import in logs.

Request body example

application/json

{
  "lightTemplate" : {
    "products" : {
      "first" : {
        "fields" : [ "brand", "title", "link", "sellingPrice", "listPrice", "inStock", "custom.material" ],
        "variants" : {
          "all" : {
            "fields" : [ "label", "inStock", "sellingPrice", "listPrice", "custom.campaign" ]
          }
        }
      },
      "rest" : {
        "fields" : [ "link", "swatch" ],
        "maxVariants" : 0
      }
    }
  }
}

Request body schema

TemplateBody

Template definitions for response object customization. Template IDs must be alphanumeric and can be up to 25 characters. Keys following pattern: [a-zA-Z0-9]{1,25} and with the value: TemplateSettings Max: 100 keys

Example request

bash

curl -i \
-X PUT \
-H 'Api-Key: 123456789..' \
-H 'Content-Encoding: gzip' \
-H 'Content-Type: application/json' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v3/import/templates?force=force&name=name" \
-T request-body.file.gz

Response

Response codes

Status	Description
`204`	The import file was valid.
`403`	Incorrect cluster credentials.
`404`	Cluster not found.
`409`	An import is currently in progress.
`500`	Server error such as cluster unavailable or busy. If 5xx errors persist, contact support and attach any information found in the response body.

POST

An import of templates for response object customization, used with the query parameter ‘templateId’. Using POST to add or remove templates will not affect templates not included in the import.

POST https://{cluster-id}.elevate-api.cloud/api/admin/v3/import/templates

Request

Request header parameters

Name	Description	Example
`Api-Key`*	API key supplied during onboarding.	`123456789..`
`Content-Encoding`	Defines which encoding was used to compress the data.	`gzip`
`Content-Type`	application/json	`application/json`

Request query parameters

Name	Description	Example
`name`	A name to identify the import in logs.

Request body example

application/json

{
  "edit" : {
    "lightTemplate" : {
      "products" : {
        "first" : {
          "fields" : [ "brand", "title", "link", "sellingPrice", "listPrice", "inStock" ],
          "variants" : {
            "all" : {
              "fields" : [ "label", "inStock", "sellingPrice", "listPrice" ]
            }
          }
        },
        "rest" : {
          "fields" : [ "link", "swatch" ],
          "maxVariants" : 0
        }
      }
    }
  },
  "remove" : [ "oldTemplate" ]
}

Request body schema

TemplatePostBody

Name	Type	Description
edit	<string, TemplateSettings>	Template definitions for response object customization. Template IDs must be alphanumeric and can be up to 25 characters. Examples: `{"lightTemplate":{"products":{"first":{"fields":["brand","title","link","sellingPrice","listPrice","inStock"],"variants":{"all":{"fields":["label","inStock","sellingPrice","listPrice"]}}},"rest":{"fields":["link","swatch"],"maxVariants":0}}}}`
remove	string[]	IDs of templates to remove. Examples: `"oldTemplate"`

Example request

bash

curl -i \
-X POST \
-H 'Api-Key: 123456789..' \
-H 'Content-Encoding: gzip' \
-H 'Content-Type: application/json' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v3/import/templates?name=name" \
-T request-body.file.gz

Response

Response codes

Status	Description
`204`	The import file was valid.
`403`	Incorrect cluster credentials.
`404`	Cluster not found.
`409`	An import is currently in progress.
`500`	Server error such as cluster unavailable or busy. If 5xx errors persist, contact support and attach any information found in the response body.

Schemas

ProductTemplate

Name	Type	Description
fields*	string[]	The product level attributes to include. Custom attributes can be included by prefixing them with `custom.`, or the special `custom.*` can be used to include all custom attributes.
maxVariants	integer	The max number of variants to include. If not specified, all variants will be included. Min: `0`. Examples: `0`
variants	VariantTemplateMapping	The definition of the product’s variants for either `all` or the `first` and `rest` of the variants. Required unless maxVariants is not set to 0.

ProductTemplateMapping

Name	Type	Description
all	ProductTemplate	All products/variants. Only if first and rest are not used.
first	ProductTemplate	The first product/variant in the list.
rest	ProductTemplate	The remaining products/variants in the list. Required if first is used.

TemplateSettings

Name	Type	Description
products*	ProductTemplateMapping	The definition of the group’s products for either `all` or the `first` and `rest` of the products.

VariantTemplate

Name	Type	Description
fields*	string[]	The variant level attributes to include. Custom attributes can be included by prefixing them with `custom.`, or the special `custom.*` can be used to include all custom attributes.

VariantTemplateMapping

Name	Type	Description
all	VariantTemplate	All products/variants. Only if first and rest are not used.
first	VariantTemplate	The first product/variant in the list.
rest	VariantTemplate	The remaining products/variants in the list. Required if first is used.

Overview

Admin

Storefront

PUT

Request

TemplateBody

Response

POST

Request

TemplatePostBody

Response

Schemas

ProductTemplate

ProductTemplateMapping

TemplateSettings

VariantTemplate

VariantTemplateMapping

​PUT

​Request

​TemplateBody

​Response

​POST

​Request

​TemplatePostBody

​Response

​Schemas

​ProductTemplate

​ProductTemplateMapping

​TemplateSettings

​VariantTemplate

​VariantTemplateMapping

PUT

Request

TemplateBody

Response

POST

Request

TemplatePostBody

Response

Schemas

ProductTemplate

ProductTemplateMapping

TemplateSettings

VariantTemplate

VariantTemplateMapping