aYOUne
← Sales API

Configurations

Singular: Configuration — Base URL: https://sale-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": {
    "appSettings": {
      "googlemaps": {
        "address": ""
      }
    },
    "_id": "65e0b1e7121b7d48fe15a3d9",
    "name": "",
    "locked": false,
    "status": "Neu",
    "createdBy": "6045f4d25704710012485569",
    "fields": [],
    "createdAt": "2024-02-29T16:33:43.433Z",
    "updatedAt": "2024-02-29T16:33:43.433Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://sale-api.ayoune.app/configurations/65e0b1e7121b7d48fe15a3d9",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "Configurators",
        "title": "MODEL_CONFIGURATOR",
        "href": "https://api.ayoune.app/config/configurators",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.configurators"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "rel": "Assignments",
        "title": "MODEL_ASSIGNMENT",
        "href": "https://api.ayoune.app/sale/assignments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.assignments"
      },
      {
        "rel": "ConfigurationMatchings",
        "title": "MODEL_CONFIGURATIONMATCHING",
        "href": "https://api.ayoune.app/config/configurationmatchings",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.configurationmatchings"
      },
      {
        "rel": "Offers",
        "title": "MODEL_OFFER",
        "href": "https://api.ayoune.app/sale/offers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.offers"
      }
    ],
    "debugId": "6a61990501c854403a7cc719",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CONFIGURATION",
        "href": "https://api.ayoune.app/sale/configurations/65e0b1e7121b7d48fe15a3d9/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CONFIGURATION",
        "href": "https://api.ayoune.app/sale/configurations/65e0b1e7121b7d48fe15a3d9/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.37.2",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2442",
      "reset": "1784784645",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 850.433447,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also