UpdateItemPrice

Update an item's price at a location. Supports updating price for a specific item, or for a specific component within a combo meal. Price changes will be applied after the business day specified in the request.

Request Parameters

BusinessDate DateTime? — The BusinessDate from when the change should apply. Default is the current BusinessDate of the location.
ChangesetName string — Optionally provide a custom "changeset" name. If the value is not passed, a default "changeset" name is created.
ItemPriceUpdates Array of ItemPriceUpdate — Specify one or more ItemPriceUpdate objects you would like to create.
ItemPriceUpdate Properties
- ItemId int — Maps to the Id of the Item to update the price for
- Price decimal — The value we would like to change the item or component item to
- ComponentId int? — Id of the group that contains details on specific child items. This is used for items that are of type combo. If ComponentId is specified, then ComponentItemId must also be specified
- ComponentItemId int? — ItemId of ItemCompositeComponentItem. This is to target a specific child item and update its price. ComponentId is required if updating the price of a ComponentItemId

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Success
- 1 — Unknown Error
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
- 5 — Settings Error
- 6 — Partial Success
Errors Array of ItemPriceUpdateError — Details if the request was unsuccessful.
ItemPriceUpdateError Properties
- ErrorCode string — Error Code for the error due to any validation failed
- Key ItemPriceUpdateKey — Specify the ItemPriceUpdateKey for error object
  ItemPriceUpdateKey Properties
  - ItemId int — Maps to the Id of the Item for which the price update failed
  - ComponentId int? — Id of the group that contains details on specific child items.
  - ComponentItemId int? — ItemId of ItemCompositeComponentItem.
  ItemCompositeComponentItem Properties
  
  Id int — Unique Id of this ItemComponent
  
  IsDefault bool — True if this item is used as the default item for this combo component, False if not
  
  ItemId int — Maps to the Id of the Item of this ItemCompositeComponentItem
  
  OverridePrice bool — True if the price specified in this dialog overrides all other prices for this item when it is in a combo, False if not
  
  Price decimal? — Enter the price of the item

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for UpdateItemPrice request containing item price updates.

Responses

text/xml; charset=utf-8

post/UpdateItemPrice

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?UpdateItemPrice' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/UpdateItemPrice"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:UpdateItemPrice>
        <v2:request>
          <v2:BusinessDate>2024-02-07T00:00:00Z</v2:BusinessDate>
          <v2:ItemPriceUpdates>
            <v2:ItemPriceUpdate>
              <v2:ItemId>4004912</v2:ItemId>
              <v2:Price>10.00</v2:Price>
            </v2:ItemPriceUpdate>
          </v2:ItemPriceUpdates>
        </v2:request>
      </v2:UpdateItemPrice>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <UpdateItemPriceResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <UpdateItemPriceResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Errors>
          <ItemPriceUpdateError>
            <ErrorCode></ErrorCode>
            <Key>
              <ItemId>101</ItemId>
              <ComponentId i:nil="true"/>
              <ComponentItemId i:nil="true"/>
            </Key>
          </ItemPriceUpdateError>
        </Errors>
      </UpdateItemPriceResult>
    </UpdateItemPriceResponse>
  </s:Body>
</s:Envelope>

SOAP response with Message and ResultCode (0 = success).