aYOUne
← Configuration API

StorageAreas

Singular: StorageArea — 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": {
    "loc": {
      "type": "Point",
      "coordinates": [
        0,
        0
      ]
    },
    "_id": "65e0b073121b7d48fe158030",
    "virtualArea": false,
    "free": true,
    "name": "",
    "color": "#ffffff",
    "labelDirection": "up",
    "strategy": "FIFO",
    "retour": false,
    "defects": false,
    "tools": false,
    "type": "",
    "kind": "Regal",
    "width": 0,
    "height": 0,
    "length": 0,
    "volume": 0,
    "volumeUsed": 0,
    "volumeUsedPercent": 0,
    "createdBy": "6045f4d25704710012485569",
    "products": [],
    "createdAt": "2024-02-29T16:27:31.285Z",
    "updatedAt": "2024-02-29T16:27:31.285Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/storageareas/65e0b073121b7d48fe158030",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Warehouses",
        "title": "MODEL_WAREHOUSE",
        "href": "https://api.ayoune.app/config/warehouses",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.warehouses"
      },
      {
        "rel": "StorageAreas",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/config/storageareas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.storageareas"
      },
      {
        "rel": "ColorCodes",
        "title": "MODEL_COLORCODE",
        "href": "https://api.ayoune.app/config/colorcodes",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.colorcodes"
      },
      {
        "rel": "Machines",
        "title": "MODEL_MACHINE",
        "href": "https://api.ayoune.app/config/machines",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.machines"
      },
      {
        "rel": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      },
      {
        "rel": "ProductionResources",
        "title": "MODEL_PRODUCTIONRESOURCE",
        "href": "https://api.ayoune.app/production/productionresources",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.productionresources"
      }
    ],
    "debugId": "6a62dedbf27d6098834b1373",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/config/storageareas/65e0b073121b7d48fe158030/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/config/storageareas/65e0b073121b7d48fe158030/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "465",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 173.290499,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also