aYOUne
← Configuration API

ShippingChannels

Singular: ShippingChannel — 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": {
    "restrictions": {
      "teams": [],
      "users": []
    },
    "_id": "65e0b070121b7d48fe157fbb",
    "check": false,
    "valid": false,
    "share": false,
    "key": "",
    "url": "",
    "booleanAs": "yn",
    "delimiter": ",",
    "quotes": "\"",
    "hasCSVColumnTitle": true,
    "ending": "default",
    "encoding": "utf8",
    "set_status": false,
    "newStatus": "Versendet",
    "createdBy": "6045f4d25704710012485569",
    "fields": [],
    "createdAt": "2024-02-29T16:27:28.088Z",
    "updatedAt": "2024-02-29T16:27:28.088Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/shippingchannels/65e0b070121b7d48fe157fbb",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62ded0f27d6098834b111f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SHIPPINGCHANNEL",
        "href": "https://api.ayoune.app/config/shippingchannels/65e0b070121b7d48fe157fbb/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SHIPPINGCHANNEL",
        "href": "https://api.ayoune.app/config/shippingchannels/65e0b070121b7d48fe157fbb/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "500",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 24.481648,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also