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

Set Retail Item Facility

Retail · REST API reference

Get support
PUT/v1/retail-items/{item_id}/facilities/{facility_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 PUT \
  --url 'https://api.staging.facily.ai/v1/retail-items/<ITEM_ID>/facilities/<FACILITY_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "par_level": 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

facility_idpath · stringrequired

Format: uuid

Request body

application/json · Required

par_levelintegerrequired

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

Minimum: 0

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "item_id": "00000000-0000-4000-8000-000000000001",
    "on_hand": 0,
    "par_level": 0,
    "price": "<VALUE_MATCHING_PATTERN>"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataFacilityRowResponserequired
Show data schema
facility_idstringrequired

The facility that carries it.

Format: uuid

item_idstringrequired

The item.

Format: uuid

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

Set Retail Item Facility | Facily Developers