createOrder

Sipariş depolama alanında bir sipariş oluşturma 🔐 Bu yöntem yetkilendirme gerektirir.

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)

Şema

marker:* string
Sipariş depolama nesnesinin metinsel tanımlayıcısı
örnek: my-order

body:* IOrderData
Bir sipariş oluşturmak için nesne
örnek:

langCode: String
İsteğe bağlı dil alanı
örnek: en_US

Şema (body)

formIdentifier: string
sipariş depolama ile bağlantılı form nesnesinin metinsel tanımlayıcısı
örnek: bars

paymentAccountIdentifier: string
sipariş depolama ile bağlantılı ödeme nesnesinin metinsel tanımlayıcısı
örnek: payment1

statusIdentifier: string
sipariş durumu nesnesinin metinsel tanımlayıcısı (belirtilmezse varsayılan durum atanacaktır)
örnek: inprogress

formData: FormDataType
sipariş deposuna bağlı form tarafından gönderilen veriler
örnek:

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

products Record<string, string | any>[]
siparişe eklenen ürünlerin dizisi

productId: number
ürün tanımlayıcısı
örnek: 12

quantity: number
ürünün miktarı
örnek: 1

Bu yöntem, bir işaretçi ile bir sipariş depolama nesnesini alır. Yöntem, isteğin gövdesine varsayılan dili ekleyecektir. Dili değiştirmek isterseniz, sadece ikinci argüman olarak geçirin.

Örnek dönüş:

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

Şema

statusIdentifier: string
sipariş durumunun metinsel tanımlayıcısı
örnek: inprogress

formIdentifier: string
form durumunun metinsel tanımlayıcısı
örnek: order-form

paymentAccountIdentifier string
sipariş ödemesinin metinsel tanımlayıcısı
örnek: payment-1

formData FormDataType
sipariş deposuna bağlı form tarafından gönderilen veriler
örnek:

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

products Record<string, string | any>[]
siparişe eklenen ürünlerin dizisi

totalSum string
siparişin toplam tutarı
örnek: 12.00

currency string
siparişin ödenmesinde kullanılan para birimi
örnek: USD

createdDate string
siparişin oluşturulduğu tarih
örnek: 2023-01-01 12:12