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
merchant_supplied_item_id	string	The MSID used for the item in the Item Management endpoint
item_availability	string	Item availability status	"ACTIVE" "INACTIVE"
balance_on_hand	integer	Current stock level for the item
last_sold_datetime	string	DateTime in ISO8601 format of when the item was last sold at the store
price_info	object	Holds different pricing parameters
base_price	number	Standard price for the item
sale_price	number	Sale price for the item
tax_rate	number	Tax rate applied for the item
bottle_fee_deposit	number	Fee collected based on local legislative requirements
base_price_per_measurement_unit	number	base price per measurement unit(kg, lb) in cents for weighted items
location	object	Default location of the item in the store
aisle	string	Aisle where the item can be found
zone	string	Zone within the aisle or a general zone within the store where the item can be found
shelf	string	Shelf within the aisle where the item can be found
side	string	Side of the aisle where the item is located
additional_details	string	Additional information about the location of the item
coordinates	object	Coordinates within the store where the item is located
coordinates.x	integer	X value of the coordinate
coordinates.y	integer	Y value of the coordinate
item_special_hours	object	Special hours when the item will be available
day_index	string	Day of the week the hours are applied	"MON" "TUE" "WED" "THU" "FRI" "SAT" "SUN"
start_time	string	Starting time of special hours	HH:MM:SS
end_time	string	Ending time of special hours	HH:MM:SS
start_date	string	Specific date when special hours should start
end_date	string	Specific date when special hours should end