Reference

Example Payload

{
  "items": [
    {
      "merchant_supplied_item_id": "string",
      "item_availability": "ACTIVE",
      "balance_on_hand": 0,
      "last_sold_datetime": "string",
      "price_info": {
        "base_price": 0,
        "sale_price": 0,
        "tax_rate": 0,
        "bottle_fee_deposit": 0,
        "base_price_per_measurement_unit": 0
      },
      "location": {
        "aisle": "string",
        "zone": "string",
        "shelf": "string",
        "side": "string",
        "additional_details": "string",
        "coordinates": {
          "x": 0,
          "y": 0
        }
      },
      "item_special_hours": [
        {
          "day_index": "MON",
          "start_time": "string",
          "end_time": "string",
          "start_date": "string",
          "end_date": "string"
        }
      ]
    }
  ]
}

Parameter Details

Parameter Name	Variable Type	Description	Possible Values	Required for POST	Required for PATCH	Required for PULL	Validation
merchant_supplied_item_id	string	The MSID used for the item in the Item Management endpoint		Yes	Yes	Yes	Must not be blank or null
item_availability	string	Item availability status	"ACTIVE" "INACTIVE"	Yes	No	Yes	Must be one of the enumerated values
balance_on_hand	integer	Current stock level for the item		Recommended	No	Recommended
last_sold_datetime	string	DateTime in ISO8601 format of when the item was last sold at the store		Recommended	No	Recommended
price_info	object	Holds different pricing parameters		Yes	No	Yes
base_price	integer	Standard price for the item (in cents)		Yes	No	Yes	Between 1 and 1000000, inclusive
sale_price	integer	Sale price for the item (in cents)		Recommended	No	Recommended	1. Must be < base_price 2. Between 1 and 1000000, inclusive
tax_rate	number	Tax rate applied for the item ("8.5%" should be sent as "8.5")		No	No	No	Between 0 and 25, inclusive
bottle_fee_deposit	number	Fee collected based on local legislative requirements (in cents)		No	No	No	Between 0 and 4000, inclusive
base_price_per_measurement_unit	number	base price per measurement unit(kg, lb) in cents for weighted items		No	No	No
location	object	Default location of the item in the store		No	No	No
aisle	string	Aisle where the item can be found		No	No	No
zone	string	Zone within the aisle or a general zone within the store where the item can be found		No	No	No
shelf	string	Shelf within the aisle where the item can be found		No	No	No
side	string	Side of the aisle where the item is located		No	No	No
additional_details	string	Additional information about the location of the item		No	No	No
coordinates	object	Coordinates within the store where the item is located		No	No	No
coordinates.x	integer	X value of the coordinate		No	No	No
coordinates.y	integer	Y value of the coordinate		No	No	No
item_special_hours	object	Special hours when the item will be available		No	No	No
day_index	string	Day of the week the hours are applied	"MON" "TUE" "WED" "THU" "FRI" "SAT" "SUN"	No	No	No
start_time	string	Starting time of special hours	HH:MM:SS	No	No	No
end_time	string	Ending time of special hours	HH:MM:SS	No	No	No
start_date	string	Specific date when special hours should start		No	No	No
end_date	string	Specific date when special hours should end		No	No	No