API - अवलोकन

API - ऑर्डर

ग्राहकों के ऑर्डर प्राप्त करें, उनकी स्थिति और मात्रा अपडेट करें और ऑर्डर हटाएँ।

एंडपॉइंट का अवलोकन

विधिएंडपॉइंटविवरणऐक्सेस
GET/public-api/v1/customer-ordersपेजिनेशन और फ़िल्टर वाली ग्राहक ऑर्डर सूची लौटाता है।orders:read
GET/public-api/v1/customer-orders/:idकॉन्फ़िगर किए गए उत्पाद आइटम के साथ एक ग्राहक ऑर्डर लौटाता है।orders:read
POST/public-api/v1/customer-orders/batchID से अधिकतम 100 ऑर्डर लौटाता है।orders:read
PATCH/public-api/v1/customer-orders/:id/statusऑर्डर की स्थिति अपडेट करता है।orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantityऑर्डर के चुने हुए विवरणों की मात्रा अपडेट करता है।orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/allऑर्डर के हर आइटम के लिए एक समान मात्रा सेट करता है।orders:write
DELETE/public-api/v1/customer-orders/:idस्टोरफ़्रंट मालिक के ग्राहक ऑर्डर को हटाता है।orders:write

ग्राहक ऑर्डर

ग्राहक ऑर्डर एंडपॉइंट से बाहरी स्टोर कॉन्फ़िगर किए गए आइटम पढ़ सकता है, मात्रा बदल सकता है, ऑर्डर को पूर्ति स्थितियों में आगे बढ़ा सकता है और छोड़े गए ऑर्डर हटा सकता है।

पैरामीटरआवश्यकविवरण
nameनहींडिज़ाइन नाम और संख्यात्मक ऑर्डर ID से खोजता है।
category_idनहींउत्पाद श्रेणी ID से फ़िल्टर करता है।
order_statusनहींस्वीकृत ऑर्डर स्थितियों में से एक।
offsetनहींडिफ़ॉल्ट 0। मान >= 0 होना चाहिए।
limitनहींइस कंट्रोलर के लिए डिफ़ॉल्ट 9, अधिकतम 50।
order_byनहींid, created_at या design_name।
directionनहींASC या DESC।

उदाहरण अनुरोध (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]
  })
});

स्वीकार्य मान

स्थितिविवरण
shopping_cartकार्ट चरण; ग्राहक अभी भी कॉन्फ़िगरेशन संपादित कर सकता है।
editableऑर्डर ग्राहक के लिए संपादन योग्य रहता है।
paidऑर्डर का भुगतान हो चुका है और वह पूर्ति के लिए तैयार है।
processingऑर्डर की पूर्ति की जा रही है।
completedऑर्डर पूरा हो चुका है।
cancelledऑर्डर रद्द कर दिया गया।

उदाहरण अनुरोध (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'
});

उदाहरण जवाब

{
  "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" }
  }
}