createOrder

إنشاء طلب في تخزين الطلبات 🔐 تتطلب هذه الطريقة تفويضًا.

Orders.createOrder(marker, body, langCode)

 const body = {
    "formIdentifier": "orderForm",
    "paymentAccountIdentifier": "cash",
    "formData": {
        "marker": "order_name",
        "value": "Ivan",
        "type": "string"
    },
    "products": [
        {
            "productId": 2,
            "quantity": 2
        }
    ]
}

const value = await Orders.createOrder('my-order', body)

Schema

marker:* string
معرف نصي لكائن تخزين الطلبات
مثال: my-order

body:* IOrderData
كائن لإنشاء طلب
مثال:

langCode: String
حقل اللغة الاختياري
مثال: en_US

Schema (body)

formIdentifier: string
معرف نصي لكائن النموذج المرتبط بتخزين الطلبات
مثال: bars

paymentAccountIdentifier: string
معرف نصي لكائن الدفع المرتبط بتخزين الطلبات
مثال: payment1

statusIdentifier: string
معرف نصي لكائن حالة الطلب (إذا لم يتم تحديده، سيتم تعيين الحالة الافتراضية)
مثال: inprogress

formData: FormDataType
البيانات المقدمة من النموذج المرتبط بمخزن الطلبات
مثال:

[
  {
    "marker": "name_1",
    "value": "Name"
  }
]

products Record<string, string | any>[]
مصفوفة من المنتجات المضافة إلى الطلب

productId: number
معرف المنتج
مثال: 12

quantity: number
كمية المنتج
مثال: 1

تسترجع هذه الطريقة كائن تخزين طلب واحد بواسطة المعرف. ستضيف الطريقة اللغة الافتراضية إلى جسم الطلب. إذا كنت ترغب في تغيير اللغة، فقط مررها كوسيط ثانٍ.

مثال على الإرجاع:

{
  "formIdentifier": "bars",
  "paymentAccountIdentifier": "payment1",
  "statusIdentifier": "inprogress",
  "formData": [
      {
        "marker": "marker_1",
        "type": "string",
        "value": "Name"
      }
  ],
  "products": [
    {
      "productId": 1,
      "quantity": 2
    },
    {
      "productId": 2,
      "quantity": 3
    }
  ],
  "createdDate": "2024-06-21T09:42:54.848Z",
  "currency": "USD",
  "totalSum": 345
}

Schema

statusIdentifier: string
معرف نصي لحالة الطلب
مثال: inprogress

formIdentifier: string
معرف نصي لحالة النموذج
مثال: order-form

paymentAccountIdentifier string
معرف نصي لدفع الطلب
مثال: payment-1

formData FormDataType
البيانات المقدمة من النموذج المرتبط بمخزن الطلبات
مثال:

[
  {
    "marker": "name_1",
    "value": "Name"
  }
]

products Record<string, string | any>[]
مصفوفة من المنتجات المضافة إلى الطلب

totalSum string
إجمالي مبلغ الطلب
مثال: 12.00

currency string
العملة المستخدمة لدفع الطلب
مثال: USD

createdDate string
التاريخ الذي تم فيه إنشاء الطلب
مثال: 2023-01-01 12:12