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

Get Retail Item

Retail · REST API reference

Get support
GET/v1/retail-items/{item_id}
The item with its sales figures: this month against last, a 90-day series, per-facility figures, its price history and its latest sales. The figures cover the facilities the caller can read.

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 GET \
  --url 'https://api.staging.facily.ai/v1/retail-items/<ITEM_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

item_idpath · stringrequired

Format: uuid

facility_idquery · string | null

Show 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
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",
    "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

dataItemDetailResponserequired
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

daily_seriesItemDayResponse[]required

The last 90 days, oldest first, zero days included.

Show daily_series schema
daystringrequired

The day.

Format: date

revenuestringrequired

Revenue, after discounts and before tax.

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

unitsintegerrequired

Units sold.

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
facility_figuresItemFacilityFiguresResponse[]required

The same figures per facility.

Show facility_figures schema
facility_idstringrequired

The facility.

Format: uuid

revenue_mtdstringrequired

Revenue this month so far, after discounts and before tax.

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

revenue_prior_mtdstringrequired

Revenue last month over the same days, after discounts and before tax.

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

units_mtdintegerrequired

Units sold this month so far.

idstringrequired

Unique identifier for this item.

Format: uuid

namestringrequired

The item's name.

periodItemPeriodResponserequired
Show period schema
revenue_mtdstringrequired

Revenue this month so far, after discounts and before tax.

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

revenue_prior_mtdstringrequired

Revenue last month over the same days, after discounts and before tax.

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

units_mtdintegerrequired

Units sold this month so far.

weekly_velocitystringrequired

Units per week over the last 90 days, one decimal.

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

pricestringrequired

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

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

price_historyPriceChangeResponse[]required

Price changes, newest first.

Show price_history 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.

recent_salesRecentSaleResponse[]required

The latest 10 sales of the item.

Show recent_sales schema
atstringrequired

When the sale was made.

Format: date-time

payer_kindstringrequired

tenant or walk_in.

quantityintegerrequired

Units of the item on the sale.

tenant_namestring | nullrequired

The tenant, or null for a walk-in.

Show tenant_name schema
string | null

The tenant, or null for a walk-in.

Variant 1: string
string
Variant 2: null
null
totalstringrequired

The item line's total with tax.

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

unit_numberstring | nullrequired

The tenant's unit, or null for a walk-in.

Show unit_number schema
string | null

The tenant's unit, or null for a walk-in.

Variant 1: string
string
Variant 2: null
null
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

Get Retail Item | Facily Developers