/v1/retail-items/{item_id}Authentication
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 GET \
--url 'https://api.staging.facily.ai/v1/retail-items/<ITEM_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
item_idpath · stringrequiredFormat: uuid
facility_idquery · string | nullShow only this facility's row of the item.
Format: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"can_edit": false,
"category_id": "00000000-0000-4000-8000-000000000001",
"cost": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"daily_series": [
{
"day": "2026-10-29",
"revenue": "<VALUE_MATCHING_PATTERN>",
"units": 0
}
],
"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>"
}
],
"facility_figures": [
{
"facility_id": "00000000-0000-4000-8000-000000000001",
"revenue_mtd": "<VALUE_MATCHING_PATTERN>",
"revenue_prior_mtd": "<VALUE_MATCHING_PATTERN>",
"units_mtd": 0
}
],
"id": "00000000-0000-4000-8000-000000000001",
"name": "string",
"period": {
"revenue_mtd": "<VALUE_MATCHING_PATTERN>",
"revenue_prior_mtd": "<VALUE_MATCHING_PATTERN>",
"units_mtd": 0,
"weekly_velocity": "<VALUE_MATCHING_PATTERN>"
},
"price": "<VALUE_MATCHING_PATTERN>",
"price_history": [
{
"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"
}
],
"recent_sales": [
{
"at": "2026-10-29T12:00:00Z",
"payer_kind": "string",
"quantity": 0,
"tenant_name": "string",
"total": "<VALUE_MATCHING_PATTERN>",
"unit_number": "string"
}
],
"sku": "string",
"taxable": false,
"updated_at": "2026-10-29T12:00:00Z"
},
"meta": {
"request_id": "string"
}
}application/json
dataItemDetailResponserequiredShow data schema
can_editbooleanrequiredTrue when the caller may change the item at every facility that carries it.
category_idstring | nullrequiredThe item's category, or null.
Format: uuid
Show category_id schema
string | nullThe item's category, or null.
Variant 1: string
stringVariant 2: null
nullcoststring | nullrequiredWhat the item costs the organization, or null.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show cost schema
string | nullWhat the item costs the organization, or null.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the item was created.
Format: date-time
daily_seriesItemDayResponse[]requiredThe last 90 days, oldest first, zero days included.
Show daily_series schema
daystringrequiredThe day.
Format: date
revenuestringrequiredRevenue, after discounts and before tax.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
unitsintegerrequiredUnits sold.
descriptionstring | nullrequiredA longer description, or null.
Show description schema
string | nullA longer description, or null.
Variant 1: string
stringVariant 2: null
nullfacilitiesItemFacilityResponse[]requiredThe facilities the caller can see that carry it.
Show facilities schema
effective_pricestringrequiredThe price a sale at this facility uses.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
facility_idstringrequiredThe facility that carries the item.
Format: uuid
is_lowbooleanrequiredWhether stock is below the facility's low-stock line of its par level.
last_received_atstring | nullrequiredWhen stock last arrived here; null if it never has.
Format: date-time
Show last_received_at schema
string | nullWhen stock last arrived here; null if it never has.
Variant 1: string
stringVariant 2: null
nullon_handintegerrequiredUnits in stock; negative when sold beyond stock.
par_levelintegerrequiredThe stock level the facility aims to keep; 0 for none.
pricestring | nullrequiredThis facility's own price, or null when it follows the item price.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show price schema
string | nullThis facility's own price, or null when it follows the item price.
Variant 1: string
stringVariant 2: null
nullfacility_figuresItemFacilityFiguresResponse[]requiredThe same figures per facility.
Show facility_figures schema
facility_idstringrequiredThe facility.
Format: uuid
revenue_mtdstringrequiredRevenue this month so far, after discounts and before tax.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
revenue_prior_mtdstringrequiredRevenue last month over the same days, after discounts and before tax.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
units_mtdintegerrequiredUnits sold this month so far.
idstringrequiredUnique identifier for this item.
Format: uuid
namestringrequiredThe item's name.
periodItemPeriodResponserequiredShow period schema
revenue_mtdstringrequiredRevenue this month so far, after discounts and before tax.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
revenue_prior_mtdstringrequiredRevenue last month over the same days, after discounts and before tax.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
units_mtdintegerrequiredUnits sold this month so far.
weekly_velocitystringrequiredUnits per week over the last 90 days, one decimal.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
pricestringrequiredThe item's price at facilities with no price of their own.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
price_historyPriceChangeResponse[]requiredPrice changes, newest first.
Show price_history 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.
recent_salesRecentSaleResponse[]requiredThe latest 10 sales of the item.
Show recent_sales schema
atstringrequiredWhen the sale was made.
Format: date-time
payer_kindstringrequiredtenant or walk_in.
quantityintegerrequiredUnits of the item on the sale.
tenant_namestring | nullrequiredThe tenant, or null for a walk-in.
Show tenant_name schema
string | nullThe tenant, or null for a walk-in.
Variant 1: string
stringVariant 2: null
nulltotalstringrequiredThe item line's total with tax.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
unit_numberstring | nullrequiredThe tenant's unit, or null for a walk-in.
Show unit_number schema
string | nullThe tenant's unit, or null for a walk-in.
Variant 1: string
stringVariant 2: null
nullskustringrequiredThe item's SKU; unique among items.
taxablebooleanrequiredWhether sales of the item are taxed.
updated_atstringrequiredWhen the item was last modified.
Format: date-time
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