updateOrderByMarkerAndId
Sipariş depolamasında sipariş değişikliği. 🔐 Bu yöntem yetkilendirme gerektirir.
Açıklama
Bu yöntem, bir sipariş depolama nesnesini işaretçi ile günceller. Yöntem, istek gövdesine varsayılan dili ekleyecektir. Dili değiştirmek isterseniz, sadece ikinci argüman olarak geçirin. Bir IBaseOrdersEntity nesnesine çözülen bir Promise döner.
Orders.updateOrderByMarkerAndId(
marker*,
id*,
body*,
body.formIdentifier*,
body.paymentAccountIdentifier*,
body.formData*,
formData.marker*,
formData.type*,
formData.value*,
body.products*,
langCode
);
Parametreler şeması
Şema
marker(zorunlu): string
Sipariş depolama nesnesinin metin tanımlayıcısı
örnek: "order_storage_1"
id(zorunlu): number
Sipariş nesnesinin ID'si
örnek: 12345
body(zorunlu): IOrderData
Bir siparişi güncellemek için nesne
örnek:
{
"formIdentifier": "bar-orders-form",
"paymentAccountIdentifier": "usd-payment",
"formData": {
"marker": "name_1",
"value": "İsim",
"type": "string"
},
"products": [
{
"productId": 1,
"quantity": 2
}
],
"currency": "USD"
}
body.formIdentifier(zorunlu): string
Sipariş deposuna bağlı form nesnesinin metin tanımlayıcısı.
örnek: "bar-orders-form"
body.paymentAccountIdentifier(zorunlu): string
Sipariş deposuna bağlı ödeme nesnesinin metin tanımlayıcısı.
örnek: "payment-1"
body.formData(zorunlu): IOrdersFormData | IOrdersFormData[]
Sipariş deposuna bağlı form verisi.
örnek:
[
{
"marker": "name_1",
"value": "İsim",
"type": "string"
}
]
formData.marker(zorunlu): string
Form alanının işaretçisi.
örnek: "name_1"
formData.type(zorunlu): string
Değerin türü.
örnek: "string"
formData.value(zorunlu): string
Değer.
örnek: "İsim"
body.products(zorunlu): IOrderProductData[]
Sipariş edilen ürünlerin dizisi.
örnek: []
langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"
Örnekler
Minimal örnek
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);
Örnek yanıt
{
"id": 55,
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "cash",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"products": [
{
"productId": 2957,
"quantity": 2
}
],
"currency": "",
"totalSum": 300
}
Yanıt şeması
Şema: IBaseOrdersEntity
id: number
Nesne tanımlayıcısı.
örnek: 1
formIdentifier: string
Formun metin tanımlayıcısı.
örnek: "bar-orders-form"
paymentAccountIdentifier: string
Sipariş ödemesinin metin tanımlayıcısı.
örnek: "payment-1"
formData: IOrdersFormData[]
Sipariş deposuna bağlı formdan gönderilen veriler.
örnek:
[
{
"marker": "name_1",
"value": "İsim",
"type": "string"
}
]
products: IOrderProductsData[]
Siparişe eklenen ürünlerin dizisi.
örnek:
[
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
]
currency: string
Sipariş için kullanılan para birimi.
örnek: "USD"
totalSum: number
Toplam sipariş tutarı.
örnek: NaN
createdDate: string
Sipariş oluşturma tarihi.
örnek: "2023-10-01T12:00:00Z"
statusIdentifier: string
Sipariş durumu nesnesinin metin tanımlayıcısı (ayarlanmadıysa varsayılan durum atanacaktır).
örnek: "status-1"