Products
POST /variant-options/apply-templates
Apply variant option templates to bulk create options with initial values
POST
/
variant-options
/
apply-templates
cURL
curl --request POST \
--url https://admin.fanfare.io/api/variant-options/apply-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templates": [
{
"displayName": "<string>",
"name": "<string>",
"initialValues": [
{
"displayValue": "<string>",
"value": "<string>",
"colorHex": "<string>",
"sortOrder": 123
}
],
"isRestricted": true
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templates: [
{
displayName: '<string>',
name: '<string>',
initialValues: [
{
displayValue: '<string>',
value: '<string>',
colorHex: '<string>',
sortOrder: 123
}
],
isRestricted: true
}
]
})
};
fetch('https://admin.fanfare.io/api/variant-options/apply-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://admin.fanfare.io/api/variant-options/apply-templates"
payload = { "templates": [
{
"displayName": "<string>",
"name": "<string>",
"initialValues": [
{
"displayValue": "<string>",
"value": "<string>",
"colorHex": "<string>",
"sortOrder": 123
}
],
"isRestricted": True
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://admin.fanfare.io/api/variant-options/apply-templates"
payload := strings.NewReader("{\n \"templates\": [\n {\n \"displayName\": \"<string>\",\n \"name\": \"<string>\",\n \"initialValues\": [\n {\n \"displayValue\": \"<string>\",\n \"value\": \"<string>\",\n \"colorHex\": \"<string>\",\n \"sortOrder\": 123\n }\n ],\n \"isRestricted\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}[
{
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"displayName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isRestricted": true,
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"values": [
{
"archived": true,
"colorHex": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"displayValue": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isCentrallyManaged": true,
"optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123,
"value": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
]
}
]{
"error": "validation_error",
"issues": [
{
"expected": "<string>",
"kind": "<string>",
"message": "<string>",
"path": [
{
"input": "<unknown>",
"key": "<string>",
"origin": "<string>",
"type": "<string>"
}
],
"received": "<string>",
"type": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Fanfare secret key. Keep secret credentials on your server.
Body
application/json
Show child attributes
Show child attributes
Response
Variant option templates applied successfully
Minimum string length:
1Minimum string length:
1Show child attributes
Show child attributes
⌘I
cURL
curl --request POST \
--url https://admin.fanfare.io/api/variant-options/apply-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templates": [
{
"displayName": "<string>",
"name": "<string>",
"initialValues": [
{
"displayValue": "<string>",
"value": "<string>",
"colorHex": "<string>",
"sortOrder": 123
}
],
"isRestricted": true
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templates: [
{
displayName: '<string>',
name: '<string>',
initialValues: [
{
displayValue: '<string>',
value: '<string>',
colorHex: '<string>',
sortOrder: 123
}
],
isRestricted: true
}
]
})
};
fetch('https://admin.fanfare.io/api/variant-options/apply-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://admin.fanfare.io/api/variant-options/apply-templates"
payload = { "templates": [
{
"displayName": "<string>",
"name": "<string>",
"initialValues": [
{
"displayValue": "<string>",
"value": "<string>",
"colorHex": "<string>",
"sortOrder": 123
}
],
"isRestricted": True
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://admin.fanfare.io/api/variant-options/apply-templates"
payload := strings.NewReader("{\n \"templates\": [\n {\n \"displayName\": \"<string>\",\n \"name\": \"<string>\",\n \"initialValues\": [\n {\n \"displayValue\": \"<string>\",\n \"value\": \"<string>\",\n \"colorHex\": \"<string>\",\n \"sortOrder\": 123\n }\n ],\n \"isRestricted\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}[
{
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"displayName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isRestricted": true,
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"values": [
{
"archived": true,
"colorHex": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"displayValue": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isCentrallyManaged": true,
"optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123,
"value": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
]
}
]{
"error": "validation_error",
"issues": [
{
"expected": "<string>",
"kind": "<string>",
"message": "<string>",
"path": [
{
"input": "<unknown>",
"key": "<string>",
"origin": "<string>",
"type": "<string>"
}
],
"received": "<string>",
"type": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}