Skip to content

ArticleDynamicStatuses

Article dynamic statuses track real-time availability of products at specific locations. Used to mark items as sold out, hidden, or disabled on kiosks and webshops.

Storage Location

{customer_id}-article_dynamic_status.json

Fields

FieldTypeRequiredDescription
idstringYesUnique status record identifier.
customer_idintegerYesReference to Customer.
article_idintegerYesReference to Article.
article_namestringYesArticle name (denormalized).
installation_idintegerYesReference to Installation.
installation_namestringYesInstallation name (denormalized).
start_atdatetimeYesStatus effective from.
end_atdatetimeYesStatus effective until.
statusstringYesAvailability status.
messagestringNoCustomer-facing message (e.g., "Sold out").
deletedstringNoSoft-delete flag ("true" if record is deleted).

Status Values

StatusDescription
hiddenArticle hidden from display (not shown on kiosk/webshop)
disabledArticle visible but not orderable
availableArticle available for sale (default, usually no record needed)

Example - Hidden Article

json
{
  "id": "768490",
  "customer_id": 10352,
  "article_id": 584768,
  "article_name": "Spesialmelk",
  "installation_id": 15136,
  "installation_name": "Kanelsnurren Østbanehallen",
  "start_at": "2025-03-30T13:17:05",
  "end_at": "2025-03-31T03:00:00",
  "status": "hidden",
  "message": "Sold out"
}

Example - Disabled Article (Soft Deleted)

json
{
  "id": "765675",
  "customer_id": 10352,
  "article_id": 584779,
  "article_name": "Brus",
  "installation_id": 15136,
  "installation_name": "Kanelsnurren Østbanehallen",
  "start_at": "2025-03-25T07:52:05",
  "end_at": "2025-03-26T03:00:00",
  "status": "disabled",
  "message": "Sold out",
  "deleted": "true"
}

Example - Multiple Statuses

json
[
  {
    "id": "768490",
    "customer_id": 10352,
    "article_id": 584768,
    "article_name": "Spesialmelk",
    "installation_id": 15136,
    "installation_name": "Kanelsnurren Østbanehallen",
    "start_at": "2025-03-30T13:17:05",
    "end_at": "2025-03-31T03:00:00",
    "status": "hidden",
    "message": "Sold out"
  },
  {
    "id": "768537",
    "customer_id": 10352,
    "article_id": 584779,
    "article_name": "Brus",
    "installation_id": 15136,
    "installation_name": "Kanelsnurren Østbanehallen",
    "start_at": "2025-03-30T12:00:00",
    "end_at": "2025-03-31T03:00:00",
    "status": "disabled",
    "message": "Sold out"
  }
]

Usage Notes

  • Statuses are time-bounded with start_at and end_at timestamps
  • Records with deleted: "true" should be ignored
  • Installation-specific: allows different availability per location
  • Commonly used for "86ing" items (kitchen term for running out)

Technical documentation for partners and integrators