aYOUne
← Configuration API

ProductGroups

Singular: ProductGroup — Base URL: https://config-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65e0b04f121b7d48fe157bdd",
    "active": true,
    "_division": [],
    "name": "-",
    "backgroundColor": "#ffffff",
    "textColor": "#000000",
    "team": "-",
    "datev_sub_id": "",
    "ext_id": "",
    "INTID": "",
    "pos": false,
    "noticeActive": false,
    "notice": "",
    "notice_en": "",
    "short_description": "",
    "short_description_en": "",
    "long_description": "",
    "long_description_en": "",
    "image_url": "",
    "additional_image_url": "",
    "advancedNbr": false,
    "attributes": [],
    "createdBy": "6045f4d25704710012485569",
    "images": [],
    "shops": [],
    "channels": [],
    "articleNumberParts": [],
    "createdAt": "2024-02-29T16:26:55.505Z",
    "updatedAt": "2024-02-29T16:26:55.505Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/productgroups/65e0b04f121b7d48fe157bdd",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "ETIMs",
        "title": "MODEL_ETIM",
        "href": "https://api.ayoune.app/config/etims",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.etims"
      }
    ],
    "debugId": "6a62de3cf27d6098834af145",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PRODUCTGROUP",
        "href": "https://api.ayoune.app/config/productgroups/65e0b04f121b7d48fe157bdd/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PRODUCTGROUP",
        "href": "https://api.ayoune.app/config/productgroups/65e0b04f121b7d48fe157bdd/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "911",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 96.282814,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /productgroups List with filters/pagination config.productgroups.view
GET /productgroups/:id Single record config.productgroups.view
POST /productgroups Create new record config.productgroups.new
PUT /productgroups Update record config.productgroups.edit
DELETE /productgroups/:id Delete record config.productgroups.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.productGroups.find().limit(10).exec();

// Single record
const one = await ay.config.productGroups.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.productGroups.create({ name: 'Foo' });

See also