getAllOrdersStorage

Mengambil semua objek penyimpanan pesanan. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini mengambil semua objek penyimpanan pesanan yang dikonfigurasi untuk proyek, dengan paginasi. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi array objek IOrdersEntity.

Orders.getAllOrdersStorage(

langCode, offset, limit

);

Skema parameter

Skema

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter opsional untuk paginasi. Default: 0
contoh: 0

limit: number
Parameter opsional untuk paginasi. Default: 30
contoh: 30

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan jumlah rekaman dalam pengaturan izin modul.
Agar paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin Modul sesuai kebutuhan Anda di bagian yang sesuai.

Contoh

Contoh minimal

const response = await Orders.getAllOrdersStorage();

Contoh dengan atribut

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

Contoh respons

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "My order"
    },
    "position": 1,
    "identifier": "my_order",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "stripe"
      },
      {
        "identifier": "cash"
      },
      {
        "identifier": "paypal"
      }
    ]
  }
]

Skema respons

Skema: IOrdersEntity[]

id: number
Identifikasi objek.
contoh: 1

localizeInfos: ILocalizeInfo
Nama yang mempertimbangkan lokalisasi.
contoh:

{
  "title": "Cash"
}

position: number | null
Posisi dalam penyimpanan pesanan.
contoh: 1

identifier: string
Identifikasi tekstual untuk bidang rekaman.
contoh: "order_storage_1"

formIdentifier: string
Identifikasi tekstual untuk formulir yang digunakan oleh penyimpanan pesanan.
contoh: "bar-orders-form"

generalTypeId: number | null
Identifikasi tipe.
contoh: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Array identifikasi tekstual dari akun pembayaran yang digunakan oleh penyimpanan pesanan.
contoh:

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

paymentAccountIdentifiers.identifier: string
Identifikasi tekstual dari akun pembayaran.
contoh: "payment-1"

---