Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsChange Retail Item Price
Search the full API reference Esc to close

Change Retail Item Price

Retail · REST API reference

Get support
POST/v1/retail-items/{item_id}/price

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
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
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

item_idpath · stringrequired

Format: uuid

Request body

application/json · Required

facility_idstring | null

Omit 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 | null

Omit or null to change the item price; a facility id to set or clear that facility's price.

Variant 1: string
string
Variant 2: null
null
pricenumber | string | null

The 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 | null

The new price. null clears a facility's own price so it follows the item price again.

Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
reasonstringrequired

Why 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
JSON · generated example
{
  "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

dataPriceChangeResponserequired
Show data schema
created_atstringrequired

When the price changed.

Format: date-time

facility_idstring | nullrequired

The facility whose price changed, or null for the item price.

Format: uuid

Show facility_id schema
string | null

The facility whose price changed, or null for the item price.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this price change.

Format: uuid

item_idstringrequired

The item whose price changed.

Format: uuid

new_pricestring | nullrequired

The price after, or null if the facility's own price was cleared.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show new_price schema
string | null

The price after, or null if the facility's own price was cleared.

Variant 1: string
string
Variant 2: null
null
old_pricestring | nullrequired

The price before, or null if the facility had none.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show old_price schema
string | null

The price before, or null if the facility had none.

Variant 1: string
string
Variant 2: null
null
reasonstringrequired

Why the price changed.

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll retail operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Change Retail Item Price | Facily Developers