API - Prezentare generală

API - Comenzi

Preluați comenzile clienților, actualizați stările și cantitățile și ștergeți comenzi.

Prezentare generală a endpointurilor

MetodăEndpointDescriereAcces
GET/public-api/v1/customer-ordersReturnează o listă paginată și filtrabilă a comenzilor clienților.orders:read
GET/public-api/v1/customer-orders/:idReturnează o comandă de client cu articole de produs configurate.orders:read
POST/public-api/v1/customer-orders/batchReturnează până la 100 de comenzi după ID.orders:read
PATCH/public-api/v1/customer-orders/:id/statusActualizează starea comenzii.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantityActualizează cantitățile pozițiilor selectate din comandă.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/allSetează o singură cantitate pentru fiecare articol dintr-o comandă.orders:write
DELETE/public-api/v1/customer-orders/:idȘterge o comandă de client care aparține proprietarului magazinului.orders:write

Comenzile clienților

Endpointurile comenzilor de client permit unui magazin extern să citească articolele configurate, să actualizeze cantitățile, să treacă o comandă prin stările de procesare și să elimine comenzile abandonate.

ParametruObligatoriuDetalii
namenuCaută după numele designului și ID-ul numeric al comenzii.
category_idnuFiltrează după ID-ul categoriei de produs.
order_statusnuUna dintre stările permise ale comenzii.
offsetnuImplicit 0. Trebuie să fie >= 0.
limitnuImplicit 9 pentru acest controler, maximum 50.
order_bynuid, created_at sau design_name.
directionnuASC sau DESC.

Exemplu de solicitare (fetch)

const params = new URLSearchParams({
  limit: '20',
  offset: '0',
  order_status: 'shopping_cart',
  order_by: 'created_at',
  direction: 'DESC'
});

const orders = await alterFetch(`/customer-orders?${params.toString()}`);

const order = await alterFetch('/customer-orders/123');

const batch = await alterFetch('/customer-orders/batch', {
  method: 'POST',
  body: JSON.stringify({
    customerOrderIds: [123, 124, 125]
  })
});

Valori permise

StareDescriere
shopping_cartFluxul coșului; clientul încă poate edita configurația.
editableComanda rămâne editabilă de către client.
paidComanda este plătită și pregătită pentru procesare.
processingComanda este în procesare.
completedComanda a fost finalizată.
cancelledComanda a fost anulată.

Exemplu de solicitare (fetch)

await alterFetch('/customer-orders/123/status', {
  method: 'PATCH',
  body: JSON.stringify({
    status: 'processing'
  })
});

await alterFetch('/customer-orders/123/quantity', {
  method: 'PATCH',
  body: JSON.stringify({
    items: [
      { orderDetailId: 987, quantity: 3 }
    ]
  })
});

await alterFetch('/customer-orders/123/quantity/all', {
  method: 'PATCH',
  body: JSON.stringify({
    quantity: 2
  })
});

await alterFetch('/customer-orders/123', {
  method: 'DELETE'
});

Exemplu de răspuns

{
  "order": {
    "id": 123,
    "customizerId": 381,
    "orderStatus": "shopping_cart",
    "createdAt": "2026-05-28T10:15:00.000Z",
    "customizerOrderURL": "https://alterproduct.com/app/customizer/381/123",
    "productItems": [
      {
        "id": 987,
        "model3d": { "id": 381 },
        "size": {
          "id": 395,
          "name": { "pl": "M", "en": "M" },
          "measureSize": null
        },
        "material": {
          "id": 2,
          "name": { "pl": "Bawełna", "en": "Cotton" }
        },
        "printType": {
          "id": 1,
          "name": { "pl": "DTG", "en": "DTG" }
        },
        "color": {
          "id": 418,
          "name": { "pl": "Domyślny", "en": "Default" },
          "hex": "#ffffff"
        },
        "variant": {
          "id": 531,
          "metadata": null,
          "stockQuantity": 25
        },
        "unitPrice": { "value": 12.5, "currency": "EUR" },
        "totalPrice": { "value": 37.5, "currency": "EUR" },
        "quantity": 3
      }
    ],
    "customizerName": "Men's T-Shirt",
    "productGroup": {
      "id": 4,
      "name": { "pl": "Koszulka", "en": "T-Shirt" }
    },
    "totalPrice": { "value": 37.5, "currency": "EUR" }
  }
}