Skip to content

Articles

Contains data on Articles (products). Articles are structured hierarchically as:

  • Article Group
    • Article Sub Group
      • Article

Storage Location

{customer_id}-article.json

Fields

FieldTypeRequiredDescription
idstringYesUnique ID. Is integer but stored as string.
namestringYesArticle name.
customer_idintegerYesRelationship to Customer owning the Article.
article_numstringYesExternal reference number, PLU or similar.
group_idintegerYesIdentifier for Article Group.
group_namestringYesName of Article Group (denormalized).
sub_group_idintegerYesIdentifier for Article Sub Group.
sub_group_namestringYesName of Article Sub Group (denormalized).
display_namestringNoOptional display name used on receipts etc.

Article Hierarchy

Articles are organized in a two-level hierarchy:

Article Group (e.g., "Boller")
└── Article Sub Group (e.g., "Bakst", "Boller")
    └── Article (e.g., "Kanelsnurr", "Croissant")

This hierarchy enables reporting and analytics at different levels of aggregation.

Example

json
{
  "id": "584734",
  "customer_id": 10352,
  "group_id": 44664,
  "group_name": "Boller",
  "sub_group_id": 79131,
  "sub_group_name": "Boller",
  "article_num": "1103",
  "name": "Kanelsnurr s"
}

Example - Article with Display Name

json
{
  "id": "644572",
  "customer_id": 10352,
  "group_id": 44664,
  "group_name": "Boller",
  "sub_group_id": 79131,
  "sub_group_name": "Boller",
  "article_num": "34353",
  "name": "Fastelavensbolle med solbær",
  "display_name": "Fastelavensbolle med solbær"
}

Example - Multiple Articles

json
[
  {
    "id": "584732",
    "customer_id": 10352,
    "group_id": 44664,
    "group_name": "Boller",
    "sub_group_id": 79131,
    "sub_group_name": "Boller",
    "article_num": "1101",
    "name": "Bringebærsnurr"
  },
  {
    "id": "584733",
    "customer_id": 10352,
    "group_id": 44664,
    "group_name": "Boller",
    "sub_group_id": 79131,
    "sub_group_name": "Boller",
    "article_num": "1102",
    "name": "Croissant"
  },
  {
    "id": "584758",
    "customer_id": 10352,
    "group_id": 44665,
    "group_name": "Drikke",
    "sub_group_id": 79140,
    "sub_group_name": "Kaffe",
    "article_num": "4202",
    "name": "Latte"
  }
]

Technical documentation for partners and integrators