Skip to content
aYOUne
← E-Commerce API

ShippingMethods

Singular: ShippingMethod — Base URL: https://ecommerce-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "6ac8118f4affa5ff19a8e88c",
    "_zone": "6ac811814affa5ff19a8e87a",
    "type": "flat_rate",
    "title": "[abnahme] Standardversand",
    "enabled": true,
    "order": 1,
    "taxable": true,
    "config": {
      "baseCost": 4.9,
      "weightBands": [
        {
          "maxKg": 2,
          "cost": 5.9
        }
      ]
    },
    "createdBy": "5a76d07e2d8b3270ff6df587",
    "shares": [],
    "createdAt": "2026-10-08T21:56:31.935Z",
    "updatedAt": "2026-10-15T06:26:31.709Z",
    "modifiedBy": "5a76d07e2d8b3270ff6df587"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://ecommerce-api.ayoune.app/shippingmethods/6ac8118f4affa5ff19a8e88c",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "ShippingZones",
        "title": "MODEL_SHIPPINGZONE",
        "href": "https://api.ayoune.app/ecommerce/shippingzones/6ac811814affa5ff19a8e87a",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ecommerce.shippingzones"
      }
    ],
    "relations": [
      {
        "rel": "ShippingZones",
        "title": "MODEL_SHIPPINGZONE",
        "href": "https://api.ayoune.app/ecommerce/shippingzones",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ecommerce.shippingzones"
      },
      {
        "rel": "BusinessLocations",
        "title": "MODEL_BUSINESSLOCATION",
        "href": "https://api.ayoune.app/config/businesslocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.businesslocations"
      }
    ],
    "debugId": "6adec9e2039adaf9a7a33278",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SHIPPINGMETHOD",
        "href": "https://api.ayoune.app/ecommerce/shippingmethods/6ac8118f4affa5ff19a8e88c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SHIPPINGMETHOD",
        "href": "https://api.ayoune.app/ecommerce/shippingmethods/6ac8118f4affa5ff19a8e88c",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.17.0",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9865",
      "reset": "1792989127",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 95.429869,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also