/v1/retail-items/{item_id}/priceAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request POST \
--url 'https://api.staging.facily.ai/v1/retail-items/<ITEM_ID>/price' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"reason": "string",
"facility_id": "00000000-0000-4000-8000-000000000001",
"price": 0
}'Parameters
item_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
facility_idstring | nullOmit or null to change the item price; a facility id to set or clear that facility's price.
Format: uuid
Show facility_id schema
string | nullOmit or null to change the item price; a facility id to set or clear that facility's price.
Variant 1: string
stringVariant 2: null
nullpricenumber | string | nullThe new price. null clears a facility's own price so it follows the item price again.
Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show price schema
number | string | nullThe new price. null clears a facility's own price so it follows the item price again.
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullreasonstringrequiredWhy the price is changing.
Min length: 1 · Max length: 1000
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
201Successful Response
{
"data": {
"created_at": "2026-10-29T12:00:00Z",
"facility_id": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001",
"item_id": "00000000-0000-4000-8000-000000000001",
"new_price": "<VALUE_MATCHING_PATTERN>",
"old_price": "<VALUE_MATCHING_PATTERN>",
"reason": "string"
},
"meta": {
"request_id": "string"
}
}application/json
dataPriceChangeResponserequiredShow data schema
created_atstringrequiredWhen the price changed.
Format: date-time
facility_idstring | nullrequiredThe facility whose price changed, or null for the item price.
Format: uuid
Show facility_id schema
string | nullThe facility whose price changed, or null for the item price.
Variant 1: string
stringVariant 2: null
nullidstringrequiredUnique identifier for this price change.
Format: uuid
item_idstringrequiredThe item whose price changed.
Format: uuid
new_pricestring | nullrequiredThe price after, or null if the facility's own price was cleared.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show new_price schema
string | nullThe price after, or null if the facility's own price was cleared.
Variant 1: string
stringVariant 2: null
nullold_pricestring | nullrequiredThe price before, or null if the facility had none.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show old_price schema
string | nullThe price before, or null if the facility had none.
Variant 1: string
stringVariant 2: null
nullreasonstringrequiredWhy the price changed.
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired