Updates details of a Product object

Updates details of a Product object specified by ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of Product to update

Body Params

Product data that needs to be changed

boolean

Flag value specifying status of this product, 'true' if active

boolean

Flag value specifying whether price overriding allowed or not, 'true' if allowed

alternate_lookup
array of strings

List of alternative names for looking up the product

alternate_lookup
uri

URI of an Attribute API object representing attribute #1 of the product

string

Description of the attribute #1 describing properties of the product

uri

URI of an Attribute API object representing attribute #2 of the product

string

Description of the attribute #2 describing properties of the product

uri

URI of an Product API object representing product with parent attribute defined

integer
enum
required

Hierarchical type of the attribute (0 - Non-hierarchical; 1 - Parent attribute; 2 - Child attribute)

Product Attribute Types:

  • 0 - PRODUCT_ATTRIBUTE_NONE
  • 1 - PRODUCT_ATTRIBUTE_PARENT
  • 2 - PRODUCT_ATTRIBUTE_CHILD
Allowed:
uri

URI of an AttributeValue API object representing actual value of the attribute #1

uri

URI of an AttributeValue API object representing actual value of the attribute #2

string

Barcode of the product (must be unique in a given Establishment)

string

Bin value

categories
array of uris

List of URI of ProductCategory API objects representing categories of the product (contains one main and additional categories objects)

categories
uri
required

URI of ProductCategory API object representing main category of the product

integer

Color code which will be used for displaying on POS

combo_discount_products
array of uris

URI of Product API object combined with discount

combo_discount_products
uri

URI of Product API object #1 combined with the current product

uri

URI of Product API object #2 combined with the current product

uri

URI of Product API object #3 combined with the current product

uri

URI of Product API object #4 combined with the current product

uri

URI of Product API object #5 combined with the current product

uri

URI of Product API object #6 combined with the current product

uri

URI of Product API object #7 combined with the current product

uri

URI of Product API object #8 combined with the current product

uri

URI of ComboProductSet API object related to the combo product set with price saving offer

string

Upcharge value for this product in combo

string

Comments to the product

string

Commission amount value for the commission type on this product

integer
enum

Commission type (0 - Amount value; 1 - Percentage)

Commission Types:

  • 0 - AMOUNT
  • 1 - PERCENTAGE
Allowed:
string

Cost of the product

integer

Number of dishes served together (course)

uri
required

URI of an User API object which is responsible for this product creation

date-time

Date and time when the product is created

boolean

Flag value specifying whether CRV enabled or not, 'true' if enabled

string

Text label of CRV

float

California Redemption Value (CRV) fee (for recyclable beverage containters)

boolean

Flag value specifying whether it is default inventory item or not, 'true' if yes

integer
enum

Delivery method ID (0 - No delivery; 1 - On site delivery; 2 - Delivery to home)

Delivery Methods:

  • 0 - DELIVERY_NO
  • 1 - DELIVERY_SITE
  • 2 - DELIVERY_HOME
Allowed:
string

Department text name or description where the product is sold

string

Additional information of the product

string

Set of dining option IDs represented as a list which in turn represented as a string (IDs are defined in the EnumDiningOption object)

boolean

Flag value specifying whether the modifier popup should be displayed on adding this item to order or not, 'true' if popup shouldn't be displayed

boolean

Flag value specifying whether this product eligible for discount or not, 'true' if yes

boolean

Flag value specifying should be this product displayed in Revel kiosk or not, 'true' if yes

boolean

Flag value specifying should be this product displayed online in Revel and third party applications or not, 'true' if yes

uri

URI of a DynamicCombo API object representing upsell combo if applied to this order item (defined in Products/Upsell combos)

boolean

Flag value spcifying whether this product eligible for purchasing with Electronic Beneift Transfer (EBT) or not, if 'true' the product cannot be purchased with EBT

boolean

Flag value specifying whether this product eligible for purchase rewards or not, 'true' if yes

date-time

Date and time of the Shell Gift end date

uri
required

URI of an Establishment API object which is related to the product

boolean

Flag value specifying whether this product eligible for export or not, 'true' if yes

external_shipping_addresses
array of uris

List of URI of Address API objects representing external shipping addresses

external_shipping_addresses
integer

Units quantity for per unit tax

float

Happy hour discount price value

string

URL to the image of the product

boolean

Flag value specifying whether the product contains alcohol 'true' if yes

boolean

Flag value specifying whether the product of 'cold type' or not (to avoid taxation e.g.) 'true' if yes

integer
enum

Types of combos

Combo Types:

  • 0 - Not a Combo
  • 1 - Group Combo
  • 2 - Split Combo
Allowed:
boolean

Flag value specifying whether the product of 'drink type' (i.e. drink or prepared at bar section) or not 'true' if yes

integer

Related to integartion with third party system (QuickBooks)

string

Additional information to assist the product preparation in the kitchen (will be visible on the KDS)

string

Name for displaying on the kitchen tickets and view

date-time

Date for displaying on the devices (product creation or modification date)

integer
enum

Fuel grade limit type (0 - No limit; 1 - By value; 2 - By volume)

Fuel Grade Limit Types:

  • 0 - NO_LIMIT
  • 1 - BY_VALUE
  • 2 - BY_VOLUME
Allowed:
string

Fuel grade limit amount accordingly to specified type (see 'limit_type')

list_printers
array of strings

List of printers for this Product object

list_printers
string

Additional information about manufacturer of the product

float

Maximum value of price allowed for this product

float

Maximum value of price for the produc including modifiers (modifiers exceeding this threshold value will be free)

float

Minimum value of price allowed for this product

string

Manufacturer's Suggested Retail Price (MSRP) value

string
required

Name of the product

boolean

Flag value specifying whether the product of 'local origin' or not 'true' if yes

boolean

Flag value specifying whether the product can be returned or not 'true' if yes

uri

URI of a Product API object representing combo of the parent object

uri

URI of a Product API object representing parent object

string

Value of price markup in percentage (used for price re-calculation on 'Percent Markup' button pressing on POS)

float

Can be set and read but purpose is unclear

integer

Number of loyality points customer rewarded for this product

boolean

Flag value specifying whether the ingredients for the product should be consumed before selling or not, 'true' if ingredients consumption occurs prior to the selling of a product

string

Recipe yield (used only for 'prep recipe')

integer

Preparation/cooking time of the product (used in kitchen)

boolean

Flag value specifying whether this product eligible for sales or not, 'true' if prohibited

float
required

Price of the product

boolean

Flag value specifying whether the product price is embedded into the barcode or not, 'true' if embedded

boolean

Flag value specifying whether this product allowed for printing tags or not, 'true' if allowed

printers
array of strings

List of printers for this Product object

printers
string

Brand name of this product

product_group
array of uris

List of URI of ProductGroup API objects representing product groups in which this product resides

product_group
string

Height of the product

string

Unit of measurement of the product height (related to `product_height')

string

Length of the product

string

Unit of measurement of the product length (related to `product_length')

string

Specific price for this product in combo.

string

Weight (mass) of the product

integer
enum

ID of unit of measurement of the product weight (0 - None; 1 - Pounds; 2 - Kilograms)

Product Weight Unit Types:

  • 0 - NONE
  • 1 - POUNDS
  • 2 - KILOGRAMS
Allowed:
string

Width of the product

string

Unit of measurement of the product width (related to `product_width')

uri

URI of a ProductClass API object representing class of this product

boolean

Flag value specifying whether the product is promotional or not, 'true' if yes

boolean

Flag value specifying whether the user will be prompted for quantity when selecting a product or not, 'true' if user will be prompted

integer

Age eligible for purchase of this product

string

Message will be displayed on this product selection

float

Reward points multiplier for this product

string

Defining of a QuickBooks Quick Pick Group (used for integration with QuickBooks POS)

string

URI of this ReceiptText API object representing recipe

string

Redemption level for the Shell Gift loyalty program

boolean

Flag value specifying whether the product required serial number for input and tracking or not, 'true' if required

string

Additional info text used in grocery retail

boolean

Flag value specifying whether the product is integrated with RTI (Remote Technologies Incorporated) products or not, 'true' if yes

boolean

Flag value specifying temporal status of the product (i.e. holiday or special deal), 'true' if product is temporal

integer

Average duration of the service (represented by this product)

boolean

Flag value specifying whether the user is eligible to set exact price for the product group (where this product is) in a product combo or not, 'true' if yes

integer

Quantity of Shelf Edge Labels to be printed

string

Stock Keeping Unit (SKU) of a product in the Shopify service

boolean

Flag value specifying whether this product eligible for displaying on POS or not, 'true' if yes

string

Stock Keeping Unit (SKU) of the product

boolean

Flag value specifying whether the product sold by weight or not, 'true' if yes

integer
required

Value representing an item position in the list

date-time

Date and time of the Shell Gift start date

string

Surcharge for the product.

float

Tare wieght i.e. weight (mass) of an empty container

uri

URI of a Tax API object related to this product

integer
enum
required

Tax class of the product which used in specific regional tax regulations (0 - None; 1 - Tax Class A; 2 - Tax Class B)

Product Tax Classes

  • 0 - NONE
  • 1 - CLASS_A
  • 2 - CLASS_B
Allowed:
tax_codes
array of strings

List of URI of TaxCode API objects representing tax codes related to the product

tax_codes
boolean

Flag value specifying whether tax include into the order item or not, 'true' if tax included

string

ID that will be used for third party integration

boolean

Flag value specifying whether the product tracked in invenory or not, 'true' if tracked

integer
enum

Product type (0 - General (regular product); 1 - Service; 2 - Fuel)

Product Types:

  • 0 - GENERAL
  • 1 - SERVICE
  • 2 - FUEL
Allowed:
string

Unit that makes up the product (i.e. sheets in a roll)

string

Unit of measurement of the product used by tracking in inventory

uri
required

URI of an User API object which is responsible for this product update

date-time

Date and time when the product updated

string

Price for upsell combo

boolean

Flag value specifying whether the price can be affected or not during bulk purchase of a product, 'true' if price can be affected

integer
enum
required

Specifing type in which way variable pricing is done (0 - By weight; 1 - By quantity)

Variable Pricing Types:

  • 0 - BY_WEIGHT
  • 1 - BY_QUANTITY
Allowed:
Responses

400

Invalid ID supplied

404

Product not found

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json