Zum Inhalt springen
aYOUne
← E-Commerce API

Orders

Singular: Order — Base-URL: https://ecommerce-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6ab22701497e7e1a34056842",
    "createdAt": "2026-09-21T09:00:00.000Z",
    "updatedAt": "2026-09-21T09:00:00.000Z",
    "_consumerID": "6ab226fe497e7e1a340566e6",
    "orderNumber": "AUF-TOL-2026-0001",
    "status": "draft",
    "positions": [
      {
        "productId": "6ab22700497e7e1a340567ea",
        "qty": 3,
        "price": 529.4,
        "tax": 19
      },
      {
        "productId": "6ab22700497e7e1a340567ee",
        "qty": 4,
        "price": 344.9,
        "tax": 19
      },
      {
        "productId": "6ab22700497e7e1a340567f2",
        "qty": 7,
        "price": 147.73,
        "tax": 19
      }
    ],
    "currency": "EUR",
    "net_total": 4001.91,
    "tax_total": 760.36,
    "discount_total": 0,
    "shipping_total": 0,
    "total": 4762.27,
    "paymentProvider": "rechnung",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://ecommerce-api.ayoune.app/orders/6ab22701497e7e1a34056842",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/6ab226fe497e7e1a340566e6",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "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": "ShoppingCarts",
        "title": "MODEL_SHOPPINGCART",
        "href": "https://api.ayoune.app/ecommerce/shoppingcarts",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ecommerce.shoppingcarts"
      },
      {
        "rel": "PaymentTransactions",
        "title": "MODEL_PAYMENTTRANSACTION",
        "href": "https://api.ayoune.app/payments/paymenttransactions",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "payments.paymenttransactions"
      },
      {
        "rel": "Affiliates",
        "title": "MODEL_AFFILIATE",
        "href": "https://api.ayoune.app/config/affiliates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.affiliates"
      },
      {
        "rel": "AffiliateAttributions",
        "title": "MODEL_AFFILIATEATTRIBUTION",
        "href": "https://api.ayoune.app/affiliate/affiliateattributions",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "affiliate.attributions"
      },
      {
        "rel": "CommissionSettlements",
        "title": "MODEL_COMMISSIONSETTLEMENT",
        "href": "https://api.ayoune.app/sale/commissionsettlements",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.commissionsettlements"
      },
      {
        "rel": "Websites",
        "title": "MODEL_WEBSITE",
        "href": "https://api.ayoune.app/cms/websites",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.websites"
      },
      {
        "rel": "ShippingMethods",
        "title": "MODEL_SHIPPINGMETHOD",
        "href": "https://api.ayoune.app/ecommerce/shippingmethods",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ecommerce.shippingmethods"
      },
      {
        "rel": "Contracts",
        "title": "MODEL_CONTRACT",
        "href": "https://api.ayoune.app/sale/contracts",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.contracts"
      }
    ],
    "debugId": "6ac9b4a3c0663a77f22ecc18",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ORDER",
        "href": "https://api.ayoune.app/ecommerce/orders/6ab22701497e7e1a34056842/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ORDER",
        "href": "https://api.ayoune.app/ecommerce/orders/6ab22701497e7e1a34056842",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.17.0",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9899",
      "reset": "1791607435",
      "resetDate": "Sat Oct 10 2026"
    },
    "responseTime": 197.212674,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /orders Liste mit Filtern/Paginierung ecommerce.orders.view
GET /orders/:id Einzelner Datensatz ecommerce.orders.view
POST /orders Neuen Datensatz erstellen ecommerce.orders.new
PUT /orders Datensatz aktualisieren ecommerce.orders.edit
DELETE /orders/:id Datensatz löschen ecommerce.orders.delete

SDK

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

// Alle abrufen
const list = await ay.ecommerce.orders.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.ecommerce.orders.findById('OBJECT_ID').exec();

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

Weiterführend