updateOrderByMarkerAndId
تعديل الطلب في تخزين الطلبات. 🔐 تتطلب هذه الطريقة التفويض.
الوصف
تقوم هذه الطريقة بتحديث كائن تخزين الطلبات بواسطة العلامة. ستضيف الطريقة اللغة الافتراضية إلى جسم الطلب. إذا كنت ترغب في تغيير اللغة، فقط مررها كوسيط ثانٍ. تُرجع وعدًا (Promise) يتم حله إلى كائن IBaseOrdersEntity.
Orders.updateOrderByMarkerAndId(
marker*,
id*,
body*,
body.formIdentifier*,
body.paymentAccountIdentifier*,
body.formData*,
formData.marker*,
formData.type*,
formData.value*,
body.products*,
langCode
);
مخطط المعلمات
المخطط
marker(مطلوب): string
المعرف النصي لكائن تخزين الطلب
مثال: "order_storage_1"
id(مطلوب): number
معرف كائن الطلب
مثال: 12345
body(مطلوب): IOrderData
كائن لتحديث الطلب
مثال:
{
"formIdentifier": "bar-orders-form",
"paymentAccountIdentifier": "usd-payment",
"formData": {
"marker": "name_1",
"value": "Name",
"type": "string"
},
"products": [
{
"productId": 1,
"quantity": 2
}
],
"currency": "USD"
}
body.formIdentifier(مطلوب): string
المعرف النصي لكائن النموذج المرتبط بمستودع الطلب.
مثال: "bar-orders-form"
body.paymentAccountIdentifier(مطلوب): string
المعرف النصي لكائن الدفع المرتبط بمستودع الطلب.
مثال: "payment-1"
body.formData(مطلوب): IOrdersFormData | IOrdersFormData[]
بيانات النموذج المرتبطة بمستودع الطلب.
مثال:
[
{
"marker": "name_1",
"value": "Name",
"type": "string"
}
]
formData.marker(مطلوب): string
علامة حقل النموذج.
مثال: "name_1"
formData.type(مطلوب): string
نوع القيمة.
مثال: "string"
formData.value(مطلوب): string
القيمة.
مثال: "Name"
body.products(مطلوب): IOrderProductData[]
مصفوفة من المنتجات المطلوبة.
مثال: []
langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"
أمثلة
مثال بسيط
const body = { "formIdentifier": "orderForm", "paymentAccountIdentifier": "cash", "formData": { { "marker": "order_name", "type": "string", "value": "Ivan" } }, "products": [ { "productId": 2, "quantity": 2 } ]};
const response = await Orders.updateOrderByMarkerAndId("my-order", 1, body);
مثال على الاستجابة
{
"id": 55,
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "cash",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"products": [
{
"productId": 2957,
"quantity": 2
}
],
"currency": "",
"totalSum": 300
}
مخطط الاستجابة
المخطط: IBaseOrdersEntity
id: number
معرف الكائن.
مثال: 1
formIdentifier: string
المعرف النصي للنموذج.
مثال: "bar-orders-form"
paymentAccountIdentifier: string
المعرف النصي لدفع الطلب.
مثال: "payment-1"
formData: IOrdersFormData[]
البيانات المقدمة بواسطة النموذج المرتبط بمستودع الطلب.
مثال:
[
{
"marker": "name_1",
"value": "Name",
"type": "string"
}
]
products: IOrderProductsData[]
مصفوفة من المنتجات المضافة إلى الطلب.
مثال:
[
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
]
currency: string
العملة المستخدمة لدفع الطلب.
مثال: "USD"
totalSum: number
إجمالي مبلغ الطلب.
مثال: NaN
createdDate: string
تاريخ إنشاء الطلب.
مثال: "2023-10-01T12:00:00Z"
statusIdentifier: string
المعرف النصي لكائن حالة الطلب (إذا لم يتم تعيينه، سيتم تعيين حالة افتراضية).
مثال: "status-1"