Create an item modifier

curl --request POST \
  --url https://api.vori.com/v1/item-modifiers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "store_id": "<string>",
  "value": "199.99"
}
'

import requests

url = "https://api.vori.com/v1/item-modifiers"

payload = {
    "name": "<string>",
    "store_id": "<string>",
    "value": "199.99"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', store_id: '<string>', value: '199.99'})
};

fetch('https://api.vori.com/v1/item-modifiers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vori.com/v1/item-modifiers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'store_id' => '<string>',
    'value' => '199.99'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vori.com/v1/item-modifiers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"store_id\": \"<string>\",\n  \"value\": \"199.99\"\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))

}

HttpResponse<String> response = Unirest.post("https://api.vori.com/v1/item-modifiers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"store_id\": \"<string>\",\n  \"value\": \"199.99\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/item-modifiers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"store_id\": \"<string>\",\n  \"value\": \"199.99\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "store_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "value": "199.99"
}

{
  "error_code": "conflicting_property_values"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {}
}

POST

item-modifiers

Create an item modifier

curl --request POST \
  --url https://api.vori.com/v1/item-modifiers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "store_id": "<string>",
  "value": "199.99"
}
'

import requests

url = "https://api.vori.com/v1/item-modifiers"

payload = {
    "name": "<string>",
    "store_id": "<string>",
    "value": "199.99"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', store_id: '<string>', value: '199.99'})
};

fetch('https://api.vori.com/v1/item-modifiers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vori.com/v1/item-modifiers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'store_id' => '<string>',
    'value' => '199.99'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vori.com/v1/item-modifiers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"store_id\": \"<string>\",\n  \"value\": \"199.99\"\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))

}

HttpResponse<String> response = Unirest.post("https://api.vori.com/v1/item-modifiers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"store_id\": \"<string>\",\n  \"value\": \"199.99\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/item-modifiers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"store_id\": \"<string>\",\n  \"value\": \"199.99\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "store_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "value": "199.99"
}

{
  "error_code": "conflicting_property_values"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

Human-readable item modifier name.

store_id

string

required

ID of the store the item modifier belongs to.

Pattern: ^[0-9]+$

type

enum<string>

required

Business purpose of the item modifier.

Available options:

bottle_deposit,

custom,

food_modifier

value

string

required

Monetary value of the modifier as a decimal string in major/minor currency units.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

price_tag_label

enum<string> | null

Optional shelf-tag classification for bottle deposits or container redemption value.

Available options:

BOTTLE_DEPOSIT,

CRV

tax_behavior

enum<string>

Whether the modifier is excluded from tax or inherits the product tax behavior.

Available options:

EXCLUDE,

INHERIT_FROM_STORE_PRODUCT

Response

A charge added alongside a product's price, such as a bottle deposit.

string

required

Unique identifier for the record.

created_at

string<date-time>

required

When the record was created.

name

string

required

Human-readable item modifier name.

price_tag_label

enum<string> | null

required

Optional shelf-tag classification for bottle deposits or container redemption value.

Available options:

BOTTLE_DEPOSIT,

CRV

store_id

string

required

ID of the store the item modifier belongs to.

Pattern: ^[0-9]+$

tax_behavior

enum<string>

required

Whether the modifier is excluded from tax or inherits the product tax behavior.

Available options:

EXCLUDE,

INHERIT_FROM_STORE_PRODUCT

type

enum<string>

required

Business purpose of the item modifier.

Available options:

bottle_deposit,

custom,

food_modifier

updated_at

string<date-time>

required

When the record was last changed.

value

string

required

Monetary value of the modifier as a decimal string in major/minor currency units.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"