aYOUne
← Sales API

Shippments

Singular: Shippment — Base URL: https://sale-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": "6a61992e01c854403a7cd50f",
    "name": "FURIOUS_COFFEE_RATTS TYEREL",
    "active": true,
    "shippingboxestemplates": [],
    "carrier": "DHL",
    "ekp": "",
    "pass": "",
    "countrycode": "DE",
    "createdBy": "6045f4d25704710012485569",
    "weight_prices": [],
    "createdAt": "2026-07-23T04:31:42.515Z",
    "updatedAt": "2026-07-23T04:31:42.515Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://sale-api.ayoune.app/shippments/6a61992e01c854403a7cd50f",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a61992f01c854403a7cd58e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SHIPPMENT",
        "href": "https://api.ayoune.app/sale/shippments/6a61992e01c854403a7cd50f/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SHIPPMENT",
        "href": "https://api.ayoune.app/sale/shippments/6a61992e01c854403a7cd50f/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.37.2",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2243",
      "reset": "1784784645",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 91.764888,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also