/v1/facilities/{facility_id}/retail-itemsAuthentication
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/facilities/<FACILITY_ID>/retail-items' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · string | stringrequiredFormat: 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",
"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"
},
"pagination": {
"has_more": false,
"limit": 0,
"cursor": "string",
"total_count": 0
},
"metrics": {
"cards": {},
"computed_at": "2026-10-29T12:00:00Z",
"is_stale": false,
"scope": "facility"
}
}application/json
dataItemResponse[]requiredShow 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
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
nullidstringrequiredUnique identifier for this item.
Format: uuid
namestringrequiredThe item's name.
pricestringrequiredThe item's price at facilities with no price of their own.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
skustringrequiredThe 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_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation 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