aYOUne
← E-Commerce API

Orders

Singular: Order — Base URL: https://ecommerce-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": {
    "_id": "6a62dfea1af8fff1cf6ee1c3",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-24T03:45:46.641Z",
    "updatedAt": "2026-07-24T03:45:46.641Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://ecommerce-api.ayoune.app/orders/6a62dfea1af8fff1cf6ee1c3",
        "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": "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": "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"
      }
    ],
    "debugId": "6a62dfeb1af8fff1cf6ee1f0",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ORDER",
        "href": "https://api.ayoune.app/ecommerce/orders/6a62dfea1af8fff1cf6ee1c3/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ORDER",
        "href": "https://api.ayoune.app/ecommerce/orders/6a62dfea1af8fff1cf6ee1c3/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.14.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2404",
      "reset": "1784868325",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 46.897689,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also