aYOUne
← Purchase API

ShippingBoxes

Singular: ShippingBox — Base URL: https://purchase-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": "65e0b1ad121b7d48fe159d94",
    "status": "Neu",
    "packageWeight": 0,
    "netWeight": 0,
    "grossWeight": 0,
    "controlWeight": 0,
    "qty": 0,
    "unit": "Palette",
    "contentQty": 0,
    "contentUnit": "Stück",
    "length": 0,
    "width": 0,
    "height": 0,
    "volume": 0,
    "maxWeight": 0,
    "maxVolume": 0,
    "createdBy": "6045f4d25704710012485569",
    "products": [],
    "createdAt": "2024-02-29T16:32:45.409Z",
    "updatedAt": "2024-02-29T16:32:45.409Z",
    "nbr": "HJGMHSR"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://purchase-api.ayoune.app/shippingboxes/65e0b1ad121b7d48fe159d94",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Warehouses",
        "title": "MODEL_WAREHOUSE",
        "href": "https://api.ayoune.app/config/warehouses",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.warehouses"
      },
      {
        "rel": "StorageAreas",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/config/storageareas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.storageareas"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "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": "Shippings",
        "title": "MODEL_SHIPPING",
        "href": "https://api.ayoune.app/sale/shippings",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.shippings"
      },
      {
        "rel": "Invoices",
        "title": "MODEL_INVOICE",
        "href": "https://api.ayoune.app/sale/invoices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.invoices"
      }
    ],
    "debugId": "6a6198c21496f64392e30109",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SHIPPINGBOX",
        "href": "https://api.ayoune.app/purchase/shippingboxes/65e0b1ad121b7d48fe159d94/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SHIPPINGBOX",
        "href": "https://api.ayoune.app/purchase/shippingboxes/65e0b1ad121b7d48fe159d94/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.10.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2437",
      "reset": "1784784576",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 187.719106,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also