getAllOrdersStorage

Tüm sipariş depolama nesnelerini almak. 🔐 Bu yöntem yetkilendirme gerektirir.

Açıklama

Bu yöntem, tüm sipariş depolama nesnelerini alır. Yöntem, isteğin gövdesine varsayılan dili ekleyecektir. Dili değiştirmek isterseniz, sadece ikinci argüman olarak geçirin. Bir dizi IOrdersEntity nesnesine çözülen bir Promise döner.

Orders.getAllOrdersStorage(

langCode, offset, limit

);

Parametreler şeması

Şema

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalamak için isteğe bağlı parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalamak için isteğe bağlı parametre. Varsayılan: 30
örnek: 30

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarındaki kayıt limitinden kaynaklanmaktadır.
Sayfalamanın doğru çalışması için, ihtiyaçlarınıza göre Modül izinlerini ilgili bölümde yapılandırmanız gerekir.

Örnekler

Minimal örnek

const response = await Orders.getAllOrdersStorage();

Özelliklerle örnek

const response = await Orders.getAllOrdersStorage('en_US', 0, 30);

Örnek yanıt

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "Siparişim"
    },
    "position": 1,
    "identifier": "my_order",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "cash"
      },
      {
        "identifier": "stripe"
      }
    ]
  }
]

Yanıt şeması

Şema: IOrdersEntity[]

id: number
Nesne tanımlayıcısı.
örnek: 1

localizeInfos: ILocalizeInfo
Yerelleştirmeyi dikkate alarak isim.
örnek:

{
  "title": "Nakit"
}

position: number | null
Sipariş depolama içindeki konum.
örnek: 1

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "order_storage_1"

formIdentifier: string
Sipariş depolama tarafından kullanılan form için metinsel tanımlayıcı.
örnek: "bar-orders-form"

generalTypeId: number | null
Tür tanımlayıcısı.
örnek: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Sipariş depolama tarafından kullanılan ödeme hesaplarının metinsel tanımlayıcılarının dizisi.
örnek:

[
  {
    "identifier": "payment-1"
  }
]

---