aYOUne
← Vertrieb API

Shippings

Singular: Shipping — Base-URL: https://sale-api.ayoune.app — Zugriff: CRUD

play_circle 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": "65e0b1f9121b7d48fe15a5da",
    "editors": [],
    "team": [],
    "stock_booked": false,
    "shipped": false,
    "invoiced": false,
    "done": false,
    "ready": false,
    "label": false,
    "assignments": [],
    "invoices": [],
    "split": false,
    "foreignCountry": false,
    "watchers": [],
    "createdBy": "6045f4d25704710012485569",
    "positions": [],
    "boxes": [],
    "comments": [],
    "createdAt": "2024-02-29T16:34:01.080Z",
    "updatedAt": "2024-02-29T16:34:01.080Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://sale-api.ayoune.app/shippings/65e0b1f9121b7d48fe15a5da",
        "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": "Shippments",
        "title": "MODEL_SHIPPMENT",
        "href": "https://api.ayoune.app/sale/shippments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.shippments"
      },
      {
        "rel": "Opportunities",
        "title": "MODEL_OPPORTUNITY",
        "href": "https://api.ayoune.app/sale/opportunities",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.opportunities"
      },
      {
        "rel": "Contracts",
        "title": "MODEL_CONTRACT",
        "href": "https://api.ayoune.app/sale/contracts",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.contracts"
      },
      {
        "rel": "Offers",
        "title": "MODEL_OFFER",
        "href": "https://api.ayoune.app/sale/offers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.offers"
      },
      {
        "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": "ProductionOrders",
        "title": "MODEL_PRODUCTIONORDER",
        "href": "https://api.ayoune.app/production/productionorders",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.productionorders"
      },
      {
        "rel": "Invoices",
        "title": "MODEL_INVOICE",
        "href": "https://api.ayoune.app/sale/invoices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.invoices"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      }
    ],
    "debugId": "6a61992c01c854403a7cd46a",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SHIPPING",
        "href": "https://api.ayoune.app/sale/shippings/65e0b1f9121b7d48fe15a5da/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SHIPPING",
        "href": "https://api.ayoune.app/sale/shippings/65e0b1f9121b7d48fe15a5da/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.37.2",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2259",
      "reset": "1784784645",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 95.967438,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend