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

Record Retail Stock

Retail · REST API reference

Get support
POST/v1/retail-items/{item_id}/facilities/{facility_id}/stock

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 POST \
  --url 'https://api.staging.facily.ai/v1/retail-items/<ITEM_ID>/facilities/<FACILITY_ID>/stock' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "kind": "received",
  "counted": 0,
  "note": "string",
  "quantity": 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

countedinteger | null

Units counted. Required for count.

Minimum: 0

Show counted schema
integer | null

Units counted. Required for count.

Variant 1: integer
integer
Variant 2: null
null
kindstringrequired

received adds stock that arrived; count sets stock to a physical count.

Values: "received", "count"

notestring | null

A note. Required for count.

Max length: 1000

Show note schema
string | null

A note. Required for count.

Variant 1: string
string
Variant 2: null
null
quantityinteger | null

Units received. Required for received.

Show quantity schema
integer | null

Units received. Required for received.

Variant 1: integer
integer
Variant 2: null
null

Responses

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

201Successful Response
JSON · generated example
{
  "data": {
    "movement": {
      "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",
      "kind": "string",
      "note": "string",
      "on_hand_after": 0,
      "quantity": 0
    }
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataStockResultResponserequired
Show data schema
movementStockMovementResponse | nullrequired

The movement recorded; null when a count matched the stock on hand and nothing changed.

Show movement schema
StockMovementResponse | null

The movement recorded; null when a count matched the stock on hand and nothing changed.

Variant 1: StockMovementResponse
created_atstringrequired

When the stock changed.

Format: date-time

facility_idstringrequired

The facility whose stock changed.

Format: uuid

idstringrequired

Unique identifier for this movement.

Format: uuid

item_idstringrequired

The item whose stock changed.

Format: uuid

kindstringrequired

opening, received, adjusted, sold or voided.

notestring | nullrequired

The note recorded with the change, or null.

Show note schema
string | null

The note recorded with the change, or null.

Variant 1: string
Variant 2: null
on_hand_afterintegerrequired

Units in stock after the change.

quantityintegerrequired

The change in units; negative when stock fell.

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

Record Retail Stock | Facily Developers