Update a store product
curl --request PATCH \
--url https://api.vori.com/v1/store-products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"active": true,
"active_store_vendor_product_id": "<string>",
"alcohol_by_volume": "199.99",
"barcode": "<string>",
"brand": "<string>",
"case_size": 123,
"country_of_origin": "<string>",
"department_id": "<string>",
"description": "<string>",
"disable_barcode_sanitization": true,
"discount_restrictions": [],
"ebt_enabled": false,
"ecommerce_enabled": false,
"food_modifier_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"ingredients": "<string>",
"is_blackhawk_gift_card": false,
"is_reloadable_blackhawk_gift_card": false,
"is_tippable": false,
"item_modifier_ids": [
"<string>"
],
"last_printed_at": "2023-11-07T05:31:56Z",
"loyalty_points_per_dollar": "199.99",
"manual_item": false,
"maximum_retail_price": "199.99",
"min_customer_age": 123,
"minimum_retail_price": "199.99",
"name": "<string>",
"notes": "<string>",
"pack_size": 123,
"print_physical_tag": false,
"prompt_for_quantity": false,
"retail_price": "199.99",
"retail_price_unit_of_measure_id": "<string>",
"shelf_life_days": 500,
"snap_incentive_earnable": false,
"snap_incentive_redeemable": false,
"sold_by_weight": false,
"store_product_group_rule_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"store_vendor_products": [
{
"storeVendorID": "<string>",
"id": "<string>",
"alternateIdentifiers": [
{
"description": "<string>"
}
],
"barcode": "<string>",
"brandName": "<string>",
"caseCost": "199.99",
"caseSize": 123,
"caseSizeDecimal": "199.99",
"caseUPC": "<string>",
"costStartTime": "2023-11-07T05:31:56Z",
"description": "<string>",
"eachCost": "199.99",
"isOrderPrimary": true,
"isPricingEligible": true,
"itemCode": "<string>",
"lbCost": "199.99",
"mutationKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packUPC": "<string>",
"parentProductID": "<string>",
"storeProductID": "<string>",
"unitUPC": "<string>",
"unitVolume": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sync_to_deli_scales": false,
"target_margin": 123,
"tax_rate_ids": [
"<string>"
],
"unit_volume_quantity": "199.99",
"unit_volume_uom_name": "<string>",
"variable_sale_price": false,
"variable_weight_ids": [
"<string>"
],
"wic_enabled": false,
"wic_override_plu": "<string>"
}
}
'import requests
url = "https://api.vori.com/v1/store-products/{id}"
payload = { "data": {
"active": True,
"active_store_vendor_product_id": "<string>",
"alcohol_by_volume": "199.99",
"barcode": "<string>",
"brand": "<string>",
"case_size": 123,
"country_of_origin": "<string>",
"department_id": "<string>",
"description": "<string>",
"disable_barcode_sanitization": True,
"discount_restrictions": [],
"ebt_enabled": False,
"ecommerce_enabled": False,
"food_modifier_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"ingredients": "<string>",
"is_blackhawk_gift_card": False,
"is_reloadable_blackhawk_gift_card": False,
"is_tippable": False,
"item_modifier_ids": ["<string>"],
"last_printed_at": "2023-11-07T05:31:56Z",
"loyalty_points_per_dollar": "199.99",
"manual_item": False,
"maximum_retail_price": "199.99",
"min_customer_age": 123,
"minimum_retail_price": "199.99",
"name": "<string>",
"notes": "<string>",
"pack_size": 123,
"print_physical_tag": False,
"prompt_for_quantity": False,
"retail_price": "199.99",
"retail_price_unit_of_measure_id": "<string>",
"shelf_life_days": 500,
"snap_incentive_earnable": False,
"snap_incentive_redeemable": False,
"sold_by_weight": False,
"store_product_group_rule_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"store_vendor_products": [
{
"storeVendorID": "<string>",
"id": "<string>",
"alternateIdentifiers": [{ "description": "<string>" }],
"barcode": "<string>",
"brandName": "<string>",
"caseCost": "199.99",
"caseSize": 123,
"caseSizeDecimal": "199.99",
"caseUPC": "<string>",
"costStartTime": "2023-11-07T05:31:56Z",
"description": "<string>",
"eachCost": "199.99",
"isOrderPrimary": True,
"isPricingEligible": True,
"itemCode": "<string>",
"lbCost": "199.99",
"mutationKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packUPC": "<string>",
"parentProductID": "<string>",
"storeProductID": "<string>",
"unitUPC": "<string>",
"unitVolume": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sync_to_deli_scales": False,
"target_margin": 123,
"tax_rate_ids": ["<string>"],
"unit_volume_quantity": "199.99",
"unit_volume_uom_name": "<string>",
"variable_sale_price": False,
"variable_weight_ids": ["<string>"],
"wic_enabled": False,
"wic_override_plu": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
active: true,
active_store_vendor_product_id: '<string>',
alcohol_by_volume: '199.99',
barcode: '<string>',
brand: '<string>',
case_size: 123,
country_of_origin: '<string>',
department_id: '<string>',
description: '<string>',
disable_barcode_sanitization: true,
discount_restrictions: [],
ebt_enabled: false,
ecommerce_enabled: false,
food_modifier_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
ingredients: '<string>',
is_blackhawk_gift_card: false,
is_reloadable_blackhawk_gift_card: false,
is_tippable: false,
item_modifier_ids: ['<string>'],
last_printed_at: '2023-11-07T05:31:56Z',
loyalty_points_per_dollar: '199.99',
manual_item: false,
maximum_retail_price: '199.99',
min_customer_age: 123,
minimum_retail_price: '199.99',
name: '<string>',
notes: '<string>',
pack_size: 123,
print_physical_tag: false,
prompt_for_quantity: false,
retail_price: '199.99',
retail_price_unit_of_measure_id: '<string>',
shelf_life_days: 500,
snap_incentive_earnable: false,
snap_incentive_redeemable: false,
sold_by_weight: false,
store_product_group_rule_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
store_vendor_products: [
{
storeVendorID: '<string>',
id: '<string>',
alternateIdentifiers: [{description: '<string>'}],
barcode: '<string>',
brandName: '<string>',
caseCost: '199.99',
caseSize: 123,
caseSizeDecimal: '199.99',
caseUPC: '<string>',
costStartTime: '2023-11-07T05:31:56Z',
description: '<string>',
eachCost: '199.99',
isOrderPrimary: true,
isPricingEligible: true,
itemCode: '<string>',
lbCost: '199.99',
mutationKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
packUPC: '<string>',
parentProductID: '<string>',
storeProductID: '<string>',
unitUPC: '<string>',
unitVolume: '<string>',
uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
sync_to_deli_scales: false,
target_margin: 123,
tax_rate_ids: ['<string>'],
unit_volume_quantity: '199.99',
unit_volume_uom_name: '<string>',
variable_sale_price: false,
variable_weight_ids: ['<string>'],
wic_enabled: false,
wic_override_plu: '<string>'
}
})
};
fetch('https://api.vori.com/v1/store-products/{id}', 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/store-products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'active' => true,
'active_store_vendor_product_id' => '<string>',
'alcohol_by_volume' => '199.99',
'barcode' => '<string>',
'brand' => '<string>',
'case_size' => 123,
'country_of_origin' => '<string>',
'department_id' => '<string>',
'description' => '<string>',
'disable_barcode_sanitization' => true,
'discount_restrictions' => [
],
'ebt_enabled' => false,
'ecommerce_enabled' => false,
'food_modifier_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'ingredients' => '<string>',
'is_blackhawk_gift_card' => false,
'is_reloadable_blackhawk_gift_card' => false,
'is_tippable' => false,
'item_modifier_ids' => [
'<string>'
],
'last_printed_at' => '2023-11-07T05:31:56Z',
'loyalty_points_per_dollar' => '199.99',
'manual_item' => false,
'maximum_retail_price' => '199.99',
'min_customer_age' => 123,
'minimum_retail_price' => '199.99',
'name' => '<string>',
'notes' => '<string>',
'pack_size' => 123,
'print_physical_tag' => false,
'prompt_for_quantity' => false,
'retail_price' => '199.99',
'retail_price_unit_of_measure_id' => '<string>',
'shelf_life_days' => 500,
'snap_incentive_earnable' => false,
'snap_incentive_redeemable' => false,
'sold_by_weight' => false,
'store_product_group_rule_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'store_vendor_products' => [
[
'storeVendorID' => '<string>',
'id' => '<string>',
'alternateIdentifiers' => [
[
'description' => '<string>'
]
],
'barcode' => '<string>',
'brandName' => '<string>',
'caseCost' => '199.99',
'caseSize' => 123,
'caseSizeDecimal' => '199.99',
'caseUPC' => '<string>',
'costStartTime' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'eachCost' => '199.99',
'isOrderPrimary' => true,
'isPricingEligible' => true,
'itemCode' => '<string>',
'lbCost' => '199.99',
'mutationKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'packUPC' => '<string>',
'parentProductID' => '<string>',
'storeProductID' => '<string>',
'unitUPC' => '<string>',
'unitVolume' => '<string>',
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'sync_to_deli_scales' => false,
'target_margin' => 123,
'tax_rate_ids' => [
'<string>'
],
'unit_volume_quantity' => '199.99',
'unit_volume_uom_name' => '<string>',
'variable_sale_price' => false,
'variable_weight_ids' => [
'<string>'
],
'wic_enabled' => false,
'wic_override_plu' => '<string>'
]
]),
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/store-products/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"active\": true,\n \"active_store_vendor_product_id\": \"<string>\",\n \"alcohol_by_volume\": \"199.99\",\n \"barcode\": \"<string>\",\n \"brand\": \"<string>\",\n \"case_size\": 123,\n \"country_of_origin\": \"<string>\",\n \"department_id\": \"<string>\",\n \"description\": \"<string>\",\n \"disable_barcode_sanitization\": true,\n \"discount_restrictions\": [],\n \"ebt_enabled\": false,\n \"ecommerce_enabled\": false,\n \"food_modifier_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"ingredients\": \"<string>\",\n \"is_blackhawk_gift_card\": false,\n \"is_reloadable_blackhawk_gift_card\": false,\n \"is_tippable\": false,\n \"item_modifier_ids\": [\n \"<string>\"\n ],\n \"last_printed_at\": \"2023-11-07T05:31:56Z\",\n \"loyalty_points_per_dollar\": \"199.99\",\n \"manual_item\": false,\n \"maximum_retail_price\": \"199.99\",\n \"min_customer_age\": 123,\n \"minimum_retail_price\": \"199.99\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"pack_size\": 123,\n \"print_physical_tag\": false,\n \"prompt_for_quantity\": false,\n \"retail_price\": \"199.99\",\n \"retail_price_unit_of_measure_id\": \"<string>\",\n \"shelf_life_days\": 500,\n \"snap_incentive_earnable\": false,\n \"snap_incentive_redeemable\": false,\n \"sold_by_weight\": false,\n \"store_product_group_rule_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"store_vendor_products\": [\n {\n \"storeVendorID\": \"<string>\",\n \"id\": \"<string>\",\n \"alternateIdentifiers\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"barcode\": \"<string>\",\n \"brandName\": \"<string>\",\n \"caseCost\": \"199.99\",\n \"caseSize\": 123,\n \"caseSizeDecimal\": \"199.99\",\n \"caseUPC\": \"<string>\",\n \"costStartTime\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"eachCost\": \"199.99\",\n \"isOrderPrimary\": true,\n \"isPricingEligible\": true,\n \"itemCode\": \"<string>\",\n \"lbCost\": \"199.99\",\n \"mutationKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packUPC\": \"<string>\",\n \"parentProductID\": \"<string>\",\n \"storeProductID\": \"<string>\",\n \"unitUPC\": \"<string>\",\n \"unitVolume\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sync_to_deli_scales\": false,\n \"target_margin\": 123,\n \"tax_rate_ids\": [\n \"<string>\"\n ],\n \"unit_volume_quantity\": \"199.99\",\n \"unit_volume_uom_name\": \"<string>\",\n \"variable_sale_price\": false,\n \"variable_weight_ids\": [\n \"<string>\"\n ],\n \"wic_enabled\": false,\n \"wic_override_plu\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.vori.com/v1/store-products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"active\": true,\n \"active_store_vendor_product_id\": \"<string>\",\n \"alcohol_by_volume\": \"199.99\",\n \"barcode\": \"<string>\",\n \"brand\": \"<string>\",\n \"case_size\": 123,\n \"country_of_origin\": \"<string>\",\n \"department_id\": \"<string>\",\n \"description\": \"<string>\",\n \"disable_barcode_sanitization\": true,\n \"discount_restrictions\": [],\n \"ebt_enabled\": false,\n \"ecommerce_enabled\": false,\n \"food_modifier_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"ingredients\": \"<string>\",\n \"is_blackhawk_gift_card\": false,\n \"is_reloadable_blackhawk_gift_card\": false,\n \"is_tippable\": false,\n \"item_modifier_ids\": [\n \"<string>\"\n ],\n \"last_printed_at\": \"2023-11-07T05:31:56Z\",\n \"loyalty_points_per_dollar\": \"199.99\",\n \"manual_item\": false,\n \"maximum_retail_price\": \"199.99\",\n \"min_customer_age\": 123,\n \"minimum_retail_price\": \"199.99\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"pack_size\": 123,\n \"print_physical_tag\": false,\n \"prompt_for_quantity\": false,\n \"retail_price\": \"199.99\",\n \"retail_price_unit_of_measure_id\": \"<string>\",\n \"shelf_life_days\": 500,\n \"snap_incentive_earnable\": false,\n \"snap_incentive_redeemable\": false,\n \"sold_by_weight\": false,\n \"store_product_group_rule_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"store_vendor_products\": [\n {\n \"storeVendorID\": \"<string>\",\n \"id\": \"<string>\",\n \"alternateIdentifiers\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"barcode\": \"<string>\",\n \"brandName\": \"<string>\",\n \"caseCost\": \"199.99\",\n \"caseSize\": 123,\n \"caseSizeDecimal\": \"199.99\",\n \"caseUPC\": \"<string>\",\n \"costStartTime\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"eachCost\": \"199.99\",\n \"isOrderPrimary\": true,\n \"isPricingEligible\": true,\n \"itemCode\": \"<string>\",\n \"lbCost\": \"199.99\",\n \"mutationKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packUPC\": \"<string>\",\n \"parentProductID\": \"<string>\",\n \"storeProductID\": \"<string>\",\n \"unitUPC\": \"<string>\",\n \"unitVolume\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sync_to_deli_scales\": false,\n \"target_margin\": 123,\n \"tax_rate_ids\": [\n \"<string>\"\n ],\n \"unit_volume_quantity\": \"199.99\",\n \"unit_volume_uom_name\": \"<string>\",\n \"variable_sale_price\": false,\n \"variable_weight_ids\": [\n \"<string>\"\n ],\n \"wic_enabled\": false,\n \"wic_override_plu\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/store-products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"active\": true,\n \"active_store_vendor_product_id\": \"<string>\",\n \"alcohol_by_volume\": \"199.99\",\n \"barcode\": \"<string>\",\n \"brand\": \"<string>\",\n \"case_size\": 123,\n \"country_of_origin\": \"<string>\",\n \"department_id\": \"<string>\",\n \"description\": \"<string>\",\n \"disable_barcode_sanitization\": true,\n \"discount_restrictions\": [],\n \"ebt_enabled\": false,\n \"ecommerce_enabled\": false,\n \"food_modifier_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"ingredients\": \"<string>\",\n \"is_blackhawk_gift_card\": false,\n \"is_reloadable_blackhawk_gift_card\": false,\n \"is_tippable\": false,\n \"item_modifier_ids\": [\n \"<string>\"\n ],\n \"last_printed_at\": \"2023-11-07T05:31:56Z\",\n \"loyalty_points_per_dollar\": \"199.99\",\n \"manual_item\": false,\n \"maximum_retail_price\": \"199.99\",\n \"min_customer_age\": 123,\n \"minimum_retail_price\": \"199.99\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"pack_size\": 123,\n \"print_physical_tag\": false,\n \"prompt_for_quantity\": false,\n \"retail_price\": \"199.99\",\n \"retail_price_unit_of_measure_id\": \"<string>\",\n \"shelf_life_days\": 500,\n \"snap_incentive_earnable\": false,\n \"snap_incentive_redeemable\": false,\n \"sold_by_weight\": false,\n \"store_product_group_rule_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"store_vendor_products\": [\n {\n \"storeVendorID\": \"<string>\",\n \"id\": \"<string>\",\n \"alternateIdentifiers\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"barcode\": \"<string>\",\n \"brandName\": \"<string>\",\n \"caseCost\": \"199.99\",\n \"caseSize\": 123,\n \"caseSizeDecimal\": \"199.99\",\n \"caseUPC\": \"<string>\",\n \"costStartTime\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"eachCost\": \"199.99\",\n \"isOrderPrimary\": true,\n \"isPricingEligible\": true,\n \"itemCode\": \"<string>\",\n \"lbCost\": \"199.99\",\n \"mutationKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packUPC\": \"<string>\",\n \"parentProductID\": \"<string>\",\n \"storeProductID\": \"<string>\",\n \"unitUPC\": \"<string>\",\n \"unitVolume\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sync_to_deli_scales\": false,\n \"target_margin\": 123,\n \"tax_rate_ids\": [\n \"<string>\"\n ],\n \"unit_volume_quantity\": \"199.99\",\n \"unit_volume_uom_name\": \"<string>\",\n \"variable_sale_price\": false,\n \"variable_weight_ids\": [\n \"<string>\"\n ],\n \"wic_enabled\": false,\n \"wic_override_plu\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"active": true,
"barcode": "<string>",
"brand": "<string>",
"country_of_origin": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"department_id": "<string>",
"description": "<string>",
"ebt_enabled": true,
"ecommerce_enabled": true,
"food_modifier_categories": [
{
"id": "<string>",
"max_selection": 123,
"min_selection": 123,
"modifiers": [
{
"id": "<string>",
"item_modifier": {
"id": "<string>",
"name": "<string>",
"value": "199.99"
},
"priority": 123
}
],
"name": "<string>",
"priority": 123
}
],
"is_blackhawk_gift_card": true,
"is_reloadable_blackhawk_gift_card": true,
"is_tippable": true,
"item_modifiers": [
{
"id": "<string>",
"name": "<string>",
"value": "199.99"
}
],
"loyalty_points_per_dollar": "199.99",
"manual_item": true,
"maximum_retail_price": "199.99",
"min_customer_age": 123,
"minimum_retail_price": "199.99",
"name": "<string>",
"prompt_for_quantity": true,
"retail_price": "199.99",
"sold_by_weight": true,
"store_id": "<string>",
"sync_to_deli_scales": false,
"target_margin": "199.99",
"tax_rates": [
{
"id": "<string>",
"name": "<string>",
"value": "8.25"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"variable_sale_price": true,
"variable_weights": [
{
"id": "<string>",
"name": "<string>",
"value": "199.99"
}
],
"wic_enabled": true,
"active_vendor": {
"id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"active_vendor_product": {
"id": "<string>",
"barcode": "<string>",
"brand_name": "<string>",
"case_cost": "199.99",
"case_cost_start_time": "2023-11-07T05:31:56Z",
"case_size": "199.99",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"each_cost": "199.99",
"each_cost_start_time": "2023-11-07T05:31:56Z",
"is_order_primary": true,
"item_code": "<string>",
"lb_cost": "199.99",
"lb_cost_start_time": "2023-11-07T05:31:56Z",
"mutation_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"store_id": "<string>",
"store_product": {
"id": "<string>",
"barcode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"store_product_id": "<string>",
"store_vendor": {
"id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"unit_volume": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"inventory": {
"current": "199.99",
"last_changed_at": "2023-11-07T05:31:56Z",
"max_stock": "<string>",
"min_par": "<string>"
},
"store_vendor_products": [
{
"id": "<string>",
"barcode": "<string>",
"brand_name": "<string>",
"case_cost": "199.99",
"case_cost_start_time": "2023-11-07T05:31:56Z",
"case_size": "199.99",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"each_cost": "199.99",
"each_cost_start_time": "2023-11-07T05:31:56Z",
"is_order_primary": true,
"item_code": "<string>",
"lb_cost": "199.99",
"lb_cost_start_time": "2023-11-07T05:31:56Z",
"mutation_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"store_id": "<string>",
"store_product": {
"id": "<string>",
"barcode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"store_product_id": "<string>",
"store_vendor": {
"id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"unit_volume": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}{
"duplicates": [
{
"barcode": "<string>",
"store_product_id": "<string>"
}
],
"error_code": "duplicate_barcode_types_for_product"
}{
"error_code": "insufficient_permissions",
"error_details": {}
}Store products
Update a store product
Update a store product
PATCH
/
v1
/
store-products
/
{id}
Update a store product
curl --request PATCH \
--url https://api.vori.com/v1/store-products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"active": true,
"active_store_vendor_product_id": "<string>",
"alcohol_by_volume": "199.99",
"barcode": "<string>",
"brand": "<string>",
"case_size": 123,
"country_of_origin": "<string>",
"department_id": "<string>",
"description": "<string>",
"disable_barcode_sanitization": true,
"discount_restrictions": [],
"ebt_enabled": false,
"ecommerce_enabled": false,
"food_modifier_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"ingredients": "<string>",
"is_blackhawk_gift_card": false,
"is_reloadable_blackhawk_gift_card": false,
"is_tippable": false,
"item_modifier_ids": [
"<string>"
],
"last_printed_at": "2023-11-07T05:31:56Z",
"loyalty_points_per_dollar": "199.99",
"manual_item": false,
"maximum_retail_price": "199.99",
"min_customer_age": 123,
"minimum_retail_price": "199.99",
"name": "<string>",
"notes": "<string>",
"pack_size": 123,
"print_physical_tag": false,
"prompt_for_quantity": false,
"retail_price": "199.99",
"retail_price_unit_of_measure_id": "<string>",
"shelf_life_days": 500,
"snap_incentive_earnable": false,
"snap_incentive_redeemable": false,
"sold_by_weight": false,
"store_product_group_rule_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"store_vendor_products": [
{
"storeVendorID": "<string>",
"id": "<string>",
"alternateIdentifiers": [
{
"description": "<string>"
}
],
"barcode": "<string>",
"brandName": "<string>",
"caseCost": "199.99",
"caseSize": 123,
"caseSizeDecimal": "199.99",
"caseUPC": "<string>",
"costStartTime": "2023-11-07T05:31:56Z",
"description": "<string>",
"eachCost": "199.99",
"isOrderPrimary": true,
"isPricingEligible": true,
"itemCode": "<string>",
"lbCost": "199.99",
"mutationKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packUPC": "<string>",
"parentProductID": "<string>",
"storeProductID": "<string>",
"unitUPC": "<string>",
"unitVolume": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sync_to_deli_scales": false,
"target_margin": 123,
"tax_rate_ids": [
"<string>"
],
"unit_volume_quantity": "199.99",
"unit_volume_uom_name": "<string>",
"variable_sale_price": false,
"variable_weight_ids": [
"<string>"
],
"wic_enabled": false,
"wic_override_plu": "<string>"
}
}
'import requests
url = "https://api.vori.com/v1/store-products/{id}"
payload = { "data": {
"active": True,
"active_store_vendor_product_id": "<string>",
"alcohol_by_volume": "199.99",
"barcode": "<string>",
"brand": "<string>",
"case_size": 123,
"country_of_origin": "<string>",
"department_id": "<string>",
"description": "<string>",
"disable_barcode_sanitization": True,
"discount_restrictions": [],
"ebt_enabled": False,
"ecommerce_enabled": False,
"food_modifier_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"ingredients": "<string>",
"is_blackhawk_gift_card": False,
"is_reloadable_blackhawk_gift_card": False,
"is_tippable": False,
"item_modifier_ids": ["<string>"],
"last_printed_at": "2023-11-07T05:31:56Z",
"loyalty_points_per_dollar": "199.99",
"manual_item": False,
"maximum_retail_price": "199.99",
"min_customer_age": 123,
"minimum_retail_price": "199.99",
"name": "<string>",
"notes": "<string>",
"pack_size": 123,
"print_physical_tag": False,
"prompt_for_quantity": False,
"retail_price": "199.99",
"retail_price_unit_of_measure_id": "<string>",
"shelf_life_days": 500,
"snap_incentive_earnable": False,
"snap_incentive_redeemable": False,
"sold_by_weight": False,
"store_product_group_rule_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"store_vendor_products": [
{
"storeVendorID": "<string>",
"id": "<string>",
"alternateIdentifiers": [{ "description": "<string>" }],
"barcode": "<string>",
"brandName": "<string>",
"caseCost": "199.99",
"caseSize": 123,
"caseSizeDecimal": "199.99",
"caseUPC": "<string>",
"costStartTime": "2023-11-07T05:31:56Z",
"description": "<string>",
"eachCost": "199.99",
"isOrderPrimary": True,
"isPricingEligible": True,
"itemCode": "<string>",
"lbCost": "199.99",
"mutationKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packUPC": "<string>",
"parentProductID": "<string>",
"storeProductID": "<string>",
"unitUPC": "<string>",
"unitVolume": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sync_to_deli_scales": False,
"target_margin": 123,
"tax_rate_ids": ["<string>"],
"unit_volume_quantity": "199.99",
"unit_volume_uom_name": "<string>",
"variable_sale_price": False,
"variable_weight_ids": ["<string>"],
"wic_enabled": False,
"wic_override_plu": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
active: true,
active_store_vendor_product_id: '<string>',
alcohol_by_volume: '199.99',
barcode: '<string>',
brand: '<string>',
case_size: 123,
country_of_origin: '<string>',
department_id: '<string>',
description: '<string>',
disable_barcode_sanitization: true,
discount_restrictions: [],
ebt_enabled: false,
ecommerce_enabled: false,
food_modifier_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
ingredients: '<string>',
is_blackhawk_gift_card: false,
is_reloadable_blackhawk_gift_card: false,
is_tippable: false,
item_modifier_ids: ['<string>'],
last_printed_at: '2023-11-07T05:31:56Z',
loyalty_points_per_dollar: '199.99',
manual_item: false,
maximum_retail_price: '199.99',
min_customer_age: 123,
minimum_retail_price: '199.99',
name: '<string>',
notes: '<string>',
pack_size: 123,
print_physical_tag: false,
prompt_for_quantity: false,
retail_price: '199.99',
retail_price_unit_of_measure_id: '<string>',
shelf_life_days: 500,
snap_incentive_earnable: false,
snap_incentive_redeemable: false,
sold_by_weight: false,
store_product_group_rule_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
store_vendor_products: [
{
storeVendorID: '<string>',
id: '<string>',
alternateIdentifiers: [{description: '<string>'}],
barcode: '<string>',
brandName: '<string>',
caseCost: '199.99',
caseSize: 123,
caseSizeDecimal: '199.99',
caseUPC: '<string>',
costStartTime: '2023-11-07T05:31:56Z',
description: '<string>',
eachCost: '199.99',
isOrderPrimary: true,
isPricingEligible: true,
itemCode: '<string>',
lbCost: '199.99',
mutationKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
packUPC: '<string>',
parentProductID: '<string>',
storeProductID: '<string>',
unitUPC: '<string>',
unitVolume: '<string>',
uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
sync_to_deli_scales: false,
target_margin: 123,
tax_rate_ids: ['<string>'],
unit_volume_quantity: '199.99',
unit_volume_uom_name: '<string>',
variable_sale_price: false,
variable_weight_ids: ['<string>'],
wic_enabled: false,
wic_override_plu: '<string>'
}
})
};
fetch('https://api.vori.com/v1/store-products/{id}', 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/store-products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'active' => true,
'active_store_vendor_product_id' => '<string>',
'alcohol_by_volume' => '199.99',
'barcode' => '<string>',
'brand' => '<string>',
'case_size' => 123,
'country_of_origin' => '<string>',
'department_id' => '<string>',
'description' => '<string>',
'disable_barcode_sanitization' => true,
'discount_restrictions' => [
],
'ebt_enabled' => false,
'ecommerce_enabled' => false,
'food_modifier_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'ingredients' => '<string>',
'is_blackhawk_gift_card' => false,
'is_reloadable_blackhawk_gift_card' => false,
'is_tippable' => false,
'item_modifier_ids' => [
'<string>'
],
'last_printed_at' => '2023-11-07T05:31:56Z',
'loyalty_points_per_dollar' => '199.99',
'manual_item' => false,
'maximum_retail_price' => '199.99',
'min_customer_age' => 123,
'minimum_retail_price' => '199.99',
'name' => '<string>',
'notes' => '<string>',
'pack_size' => 123,
'print_physical_tag' => false,
'prompt_for_quantity' => false,
'retail_price' => '199.99',
'retail_price_unit_of_measure_id' => '<string>',
'shelf_life_days' => 500,
'snap_incentive_earnable' => false,
'snap_incentive_redeemable' => false,
'sold_by_weight' => false,
'store_product_group_rule_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'store_vendor_products' => [
[
'storeVendorID' => '<string>',
'id' => '<string>',
'alternateIdentifiers' => [
[
'description' => '<string>'
]
],
'barcode' => '<string>',
'brandName' => '<string>',
'caseCost' => '199.99',
'caseSize' => 123,
'caseSizeDecimal' => '199.99',
'caseUPC' => '<string>',
'costStartTime' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'eachCost' => '199.99',
'isOrderPrimary' => true,
'isPricingEligible' => true,
'itemCode' => '<string>',
'lbCost' => '199.99',
'mutationKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'packUPC' => '<string>',
'parentProductID' => '<string>',
'storeProductID' => '<string>',
'unitUPC' => '<string>',
'unitVolume' => '<string>',
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'sync_to_deli_scales' => false,
'target_margin' => 123,
'tax_rate_ids' => [
'<string>'
],
'unit_volume_quantity' => '199.99',
'unit_volume_uom_name' => '<string>',
'variable_sale_price' => false,
'variable_weight_ids' => [
'<string>'
],
'wic_enabled' => false,
'wic_override_plu' => '<string>'
]
]),
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/store-products/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"active\": true,\n \"active_store_vendor_product_id\": \"<string>\",\n \"alcohol_by_volume\": \"199.99\",\n \"barcode\": \"<string>\",\n \"brand\": \"<string>\",\n \"case_size\": 123,\n \"country_of_origin\": \"<string>\",\n \"department_id\": \"<string>\",\n \"description\": \"<string>\",\n \"disable_barcode_sanitization\": true,\n \"discount_restrictions\": [],\n \"ebt_enabled\": false,\n \"ecommerce_enabled\": false,\n \"food_modifier_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"ingredients\": \"<string>\",\n \"is_blackhawk_gift_card\": false,\n \"is_reloadable_blackhawk_gift_card\": false,\n \"is_tippable\": false,\n \"item_modifier_ids\": [\n \"<string>\"\n ],\n \"last_printed_at\": \"2023-11-07T05:31:56Z\",\n \"loyalty_points_per_dollar\": \"199.99\",\n \"manual_item\": false,\n \"maximum_retail_price\": \"199.99\",\n \"min_customer_age\": 123,\n \"minimum_retail_price\": \"199.99\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"pack_size\": 123,\n \"print_physical_tag\": false,\n \"prompt_for_quantity\": false,\n \"retail_price\": \"199.99\",\n \"retail_price_unit_of_measure_id\": \"<string>\",\n \"shelf_life_days\": 500,\n \"snap_incentive_earnable\": false,\n \"snap_incentive_redeemable\": false,\n \"sold_by_weight\": false,\n \"store_product_group_rule_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"store_vendor_products\": [\n {\n \"storeVendorID\": \"<string>\",\n \"id\": \"<string>\",\n \"alternateIdentifiers\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"barcode\": \"<string>\",\n \"brandName\": \"<string>\",\n \"caseCost\": \"199.99\",\n \"caseSize\": 123,\n \"caseSizeDecimal\": \"199.99\",\n \"caseUPC\": \"<string>\",\n \"costStartTime\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"eachCost\": \"199.99\",\n \"isOrderPrimary\": true,\n \"isPricingEligible\": true,\n \"itemCode\": \"<string>\",\n \"lbCost\": \"199.99\",\n \"mutationKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packUPC\": \"<string>\",\n \"parentProductID\": \"<string>\",\n \"storeProductID\": \"<string>\",\n \"unitUPC\": \"<string>\",\n \"unitVolume\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sync_to_deli_scales\": false,\n \"target_margin\": 123,\n \"tax_rate_ids\": [\n \"<string>\"\n ],\n \"unit_volume_quantity\": \"199.99\",\n \"unit_volume_uom_name\": \"<string>\",\n \"variable_sale_price\": false,\n \"variable_weight_ids\": [\n \"<string>\"\n ],\n \"wic_enabled\": false,\n \"wic_override_plu\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.vori.com/v1/store-products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"active\": true,\n \"active_store_vendor_product_id\": \"<string>\",\n \"alcohol_by_volume\": \"199.99\",\n \"barcode\": \"<string>\",\n \"brand\": \"<string>\",\n \"case_size\": 123,\n \"country_of_origin\": \"<string>\",\n \"department_id\": \"<string>\",\n \"description\": \"<string>\",\n \"disable_barcode_sanitization\": true,\n \"discount_restrictions\": [],\n \"ebt_enabled\": false,\n \"ecommerce_enabled\": false,\n \"food_modifier_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"ingredients\": \"<string>\",\n \"is_blackhawk_gift_card\": false,\n \"is_reloadable_blackhawk_gift_card\": false,\n \"is_tippable\": false,\n \"item_modifier_ids\": [\n \"<string>\"\n ],\n \"last_printed_at\": \"2023-11-07T05:31:56Z\",\n \"loyalty_points_per_dollar\": \"199.99\",\n \"manual_item\": false,\n \"maximum_retail_price\": \"199.99\",\n \"min_customer_age\": 123,\n \"minimum_retail_price\": \"199.99\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"pack_size\": 123,\n \"print_physical_tag\": false,\n \"prompt_for_quantity\": false,\n \"retail_price\": \"199.99\",\n \"retail_price_unit_of_measure_id\": \"<string>\",\n \"shelf_life_days\": 500,\n \"snap_incentive_earnable\": false,\n \"snap_incentive_redeemable\": false,\n \"sold_by_weight\": false,\n \"store_product_group_rule_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"store_vendor_products\": [\n {\n \"storeVendorID\": \"<string>\",\n \"id\": \"<string>\",\n \"alternateIdentifiers\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"barcode\": \"<string>\",\n \"brandName\": \"<string>\",\n \"caseCost\": \"199.99\",\n \"caseSize\": 123,\n \"caseSizeDecimal\": \"199.99\",\n \"caseUPC\": \"<string>\",\n \"costStartTime\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"eachCost\": \"199.99\",\n \"isOrderPrimary\": true,\n \"isPricingEligible\": true,\n \"itemCode\": \"<string>\",\n \"lbCost\": \"199.99\",\n \"mutationKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packUPC\": \"<string>\",\n \"parentProductID\": \"<string>\",\n \"storeProductID\": \"<string>\",\n \"unitUPC\": \"<string>\",\n \"unitVolume\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sync_to_deli_scales\": false,\n \"target_margin\": 123,\n \"tax_rate_ids\": [\n \"<string>\"\n ],\n \"unit_volume_quantity\": \"199.99\",\n \"unit_volume_uom_name\": \"<string>\",\n \"variable_sale_price\": false,\n \"variable_weight_ids\": [\n \"<string>\"\n ],\n \"wic_enabled\": false,\n \"wic_override_plu\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/store-products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"active\": true,\n \"active_store_vendor_product_id\": \"<string>\",\n \"alcohol_by_volume\": \"199.99\",\n \"barcode\": \"<string>\",\n \"brand\": \"<string>\",\n \"case_size\": 123,\n \"country_of_origin\": \"<string>\",\n \"department_id\": \"<string>\",\n \"description\": \"<string>\",\n \"disable_barcode_sanitization\": true,\n \"discount_restrictions\": [],\n \"ebt_enabled\": false,\n \"ecommerce_enabled\": false,\n \"food_modifier_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"ingredients\": \"<string>\",\n \"is_blackhawk_gift_card\": false,\n \"is_reloadable_blackhawk_gift_card\": false,\n \"is_tippable\": false,\n \"item_modifier_ids\": [\n \"<string>\"\n ],\n \"last_printed_at\": \"2023-11-07T05:31:56Z\",\n \"loyalty_points_per_dollar\": \"199.99\",\n \"manual_item\": false,\n \"maximum_retail_price\": \"199.99\",\n \"min_customer_age\": 123,\n \"minimum_retail_price\": \"199.99\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"pack_size\": 123,\n \"print_physical_tag\": false,\n \"prompt_for_quantity\": false,\n \"retail_price\": \"199.99\",\n \"retail_price_unit_of_measure_id\": \"<string>\",\n \"shelf_life_days\": 500,\n \"snap_incentive_earnable\": false,\n \"snap_incentive_redeemable\": false,\n \"sold_by_weight\": false,\n \"store_product_group_rule_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"store_vendor_products\": [\n {\n \"storeVendorID\": \"<string>\",\n \"id\": \"<string>\",\n \"alternateIdentifiers\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"barcode\": \"<string>\",\n \"brandName\": \"<string>\",\n \"caseCost\": \"199.99\",\n \"caseSize\": 123,\n \"caseSizeDecimal\": \"199.99\",\n \"caseUPC\": \"<string>\",\n \"costStartTime\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"eachCost\": \"199.99\",\n \"isOrderPrimary\": true,\n \"isPricingEligible\": true,\n \"itemCode\": \"<string>\",\n \"lbCost\": \"199.99\",\n \"mutationKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"packUPC\": \"<string>\",\n \"parentProductID\": \"<string>\",\n \"storeProductID\": \"<string>\",\n \"unitUPC\": \"<string>\",\n \"unitVolume\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"sync_to_deli_scales\": false,\n \"target_margin\": 123,\n \"tax_rate_ids\": [\n \"<string>\"\n ],\n \"unit_volume_quantity\": \"199.99\",\n \"unit_volume_uom_name\": \"<string>\",\n \"variable_sale_price\": false,\n \"variable_weight_ids\": [\n \"<string>\"\n ],\n \"wic_enabled\": false,\n \"wic_override_plu\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"active": true,
"barcode": "<string>",
"brand": "<string>",
"country_of_origin": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"department_id": "<string>",
"description": "<string>",
"ebt_enabled": true,
"ecommerce_enabled": true,
"food_modifier_categories": [
{
"id": "<string>",
"max_selection": 123,
"min_selection": 123,
"modifiers": [
{
"id": "<string>",
"item_modifier": {
"id": "<string>",
"name": "<string>",
"value": "199.99"
},
"priority": 123
}
],
"name": "<string>",
"priority": 123
}
],
"is_blackhawk_gift_card": true,
"is_reloadable_blackhawk_gift_card": true,
"is_tippable": true,
"item_modifiers": [
{
"id": "<string>",
"name": "<string>",
"value": "199.99"
}
],
"loyalty_points_per_dollar": "199.99",
"manual_item": true,
"maximum_retail_price": "199.99",
"min_customer_age": 123,
"minimum_retail_price": "199.99",
"name": "<string>",
"prompt_for_quantity": true,
"retail_price": "199.99",
"sold_by_weight": true,
"store_id": "<string>",
"sync_to_deli_scales": false,
"target_margin": "199.99",
"tax_rates": [
{
"id": "<string>",
"name": "<string>",
"value": "8.25"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"variable_sale_price": true,
"variable_weights": [
{
"id": "<string>",
"name": "<string>",
"value": "199.99"
}
],
"wic_enabled": true,
"active_vendor": {
"id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"active_vendor_product": {
"id": "<string>",
"barcode": "<string>",
"brand_name": "<string>",
"case_cost": "199.99",
"case_cost_start_time": "2023-11-07T05:31:56Z",
"case_size": "199.99",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"each_cost": "199.99",
"each_cost_start_time": "2023-11-07T05:31:56Z",
"is_order_primary": true,
"item_code": "<string>",
"lb_cost": "199.99",
"lb_cost_start_time": "2023-11-07T05:31:56Z",
"mutation_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"store_id": "<string>",
"store_product": {
"id": "<string>",
"barcode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"store_product_id": "<string>",
"store_vendor": {
"id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"unit_volume": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"inventory": {
"current": "199.99",
"last_changed_at": "2023-11-07T05:31:56Z",
"max_stock": "<string>",
"min_par": "<string>"
},
"store_vendor_products": [
{
"id": "<string>",
"barcode": "<string>",
"brand_name": "<string>",
"case_cost": "199.99",
"case_cost_start_time": "2023-11-07T05:31:56Z",
"case_size": "199.99",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"each_cost": "199.99",
"each_cost_start_time": "2023-11-07T05:31:56Z",
"is_order_primary": true,
"item_code": "<string>",
"lb_cost": "199.99",
"lb_cost_start_time": "2023-11-07T05:31:56Z",
"mutation_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"store_id": "<string>",
"store_product": {
"id": "<string>",
"barcode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"store_product_id": "<string>",
"store_vendor": {
"id": "<string>",
"code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"unit_volume": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}{
"duplicates": [
{
"barcode": "<string>",
"store_product_id": "<string>"
}
],
"error_code": "duplicate_barcode_types_for_product"
}{
"error_code": "insufficient_permissions",
"error_details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^[0-9]+$Body
application/json
Show child attributes
Show child attributes
Response
A product as it is sold at a single store, carrying its price, barcodes, department, and inventory settings.
Unique identifier for the record.
Whether the product is active.
Primary barcode.
Brand name.
ISO 3166-1 alpha-3 country code of origin.
Required string length:
3When the record was created.
ID of the store department this product belongs to.
Pattern:
^[0-9]+$Short description, intended for character-limited use cases (e.g., printed receipts).
Whether the product is eligible for EBT/SNAP payment.
Whether the product is available for e-commerce.
Food modifier categories, and their modifiers, available for this product, ordered by category priority.
Show child attributes
Show child attributes
Whether the product is a Blackhawk gift card.
Whether the product is a reloadable Blackhawk gift card.
Whether purchases of this product can include a tip.
Item modifiers available for this product.
Show child attributes
Show child attributes
Loyalty points earned per dollar spent. Null defaults to one point per dollar.
Pattern:
^[0-9]+(\.[0-9]+)?$Example:
"199.99"
Whether the product is entered manually at the register rather than scanned.
Upper bound for the retail price, in dollars. This is typically only used for variable-priced gift cards.
Pattern:
^[0-9]+(\.[0-9]+)?$Example:
"199.99"
Minimum customer age, in years, required to purchase.
Lower bound for the retail price, in dollars. This is typically only used for variable-priced gift cards.
Pattern:
^[0-9]+(\.[0-9]+)?$Example:
"199.99"
Human-readable product name.
Whether the register prompts for a quantity when the product is scanned.
Current shelf/retail price in dollars.
Pattern:
^[0-9]+(\.[0-9]+)?$Example:
"199.99"
Whether the product is sold by weight rather than by unit.
ID of the store this product belongs to.
Pattern:
^[0-9]+$Whether the product is synchronized to deli scales.
Target gross margin for pricing decisions, as a whole-number percentage (35 means 35%).
Pattern:
^-?[0-9]+(\.[0-9]+)?$Example:
"199.99"
Tax rates applied to this product at the register.
Show child attributes
Show child attributes
When the record was last changed.
Whether the sale price is entered at the register instead of fixed.
Preset weights for products sold by weight.
Show child attributes
Show child attributes
Whether the product is eligible for WIC payment.
The vendor currently supplying this product.
Show child attributes
Show child attributes
The vendor catalog entry currently supplying this product.
Show child attributes
Show child attributes
Current inventory levels. Included when requested via include=inventory.
Show child attributes
Show child attributes
Vendor catalog entries for this product.
Show child attributes
Show child attributes
Related topics
Understanding user rolesUpdate a store departmentBuild Your Product List (APL) From Scratch – For New StoresWas this page helpful?
⌘I