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

Update Retail Item

Retail · REST API reference

Get support
PATCH/v1/retail-items/{item_id}

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 PATCH \
  --url 'https://api.staging.facily.ai/v1/retail-items/<ITEM_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "category_id": "00000000-0000-4000-8000-000000000001",
  "cost": 0,
  "description": "string",
  "name": "string",
  "taxable": false
}'
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

category_idstring | null

The new category; null clears it.

Format: uuid

Show category_id schema
string | null

The new category; null clears it.

Variant 1: string
string
Variant 2: null
null
costnumber | string | null

The new cost; null clears it.

Minimum: 0 · Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)

Show cost schema
number | string | null

The new cost; null clears it.

Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
descriptionstring | null

The new description; null clears it.

Show description schema
string | null

The new description; null clears it.

Variant 1: string
string
Variant 2: null
null
namestring | null

The new name.

Min length: 1 · Max length: 120

Show name schema
string | null

The new name.

Variant 1: string
string
Variant 2: null
null
taxableboolean | null

Whether sales of the item are taxed.

Show taxable schema
boolean | null

Whether sales of the item are taxed.

Variant 1: boolean
boolean
Variant 2: null
null

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "can_edit": false,
    "category_id": "00000000-0000-4000-8000-000000000001",
    "cost": "<VALUE_MATCHING_PATTERN>",
    "created_at": "2026-10-29T12:00:00Z",
    "description": "string",
    "facilities": [
      {
        "effective_price": "<VALUE_MATCHING_PATTERN>",
        "facility_id": "00000000-0000-4000-8000-000000000001",
        "is_low": false,
        "last_received_at": "2026-10-29T12:00:00Z",
        "on_hand": 0,
        "par_level": 0,
        "price": "<VALUE_MATCHING_PATTERN>"
      }
    ],
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "price": "<VALUE_MATCHING_PATTERN>",
    "sku": "string",
    "taxable": false,
    "updated_at": "2026-10-29T12:00:00Z"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataItemResponserequired
Show data schema
can_editbooleanrequired

True when the caller may change the item at every facility that carries it.

category_idstring | nullrequired

The item's category, or null.

Format: uuid

Show category_id schema
string | null

The item's category, or null.

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

What the item costs the organization, or null.

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

Show cost schema
string | null

What the item costs the organization, or null.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the item was created.

Format: date-time

descriptionstring | nullrequired

A longer description, or null.

Show description schema
string | null

A longer description, or null.

Variant 1: string
string
Variant 2: null
null
facilitiesItemFacilityResponse[]required

The facilities the caller can see that carry it.

Show facilities schema
effective_pricestringrequired

The price a sale at this facility uses.

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

facility_idstringrequired

The facility that carries the item.

Format: uuid

is_lowbooleanrequired

Whether stock is below the facility's low-stock line of its par level.

last_received_atstring | nullrequired

When stock last arrived here; null if it never has.

Format: date-time

Show last_received_at schema
string | null

When stock last arrived here; null if it never has.

Variant 1: string
string
Variant 2: null
null
on_handintegerrequired

Units in stock; negative when sold beyond stock.

par_levelintegerrequired

The stock level the facility aims to keep; 0 for none.

pricestring | nullrequired

This facility's own price, or null when it follows the item price.

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

Show price schema
string | null

This facility's own price, or null when it follows the item price.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this item.

Format: uuid

namestringrequired

The item's name.

pricestringrequired

The item's price at facilities with no price of their own.

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

skustringrequired

The item's SKU; unique among items.

taxablebooleanrequired

Whether sales of the item are taxed.

updated_atstringrequired

When the item was last modified.

Format: date-time

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

Update Retail Item | Facily Developers