getAllOrdersStorage

Lấy tất cả các đối tượng lưu trữ đơn hàng. 🔐 Phương thức này yêu cầu ủy quyền.

Mô tả

Phương thức này truy xuất tất cả các đối tượng lưu trữ đơn hàng được cấu hình cho dự án, với phân trang. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng IOrdersEntity.

Orders.getAllOrdersStorage(

langCode, offset, limit

);

Sơ đồ tham số

Sơ đồ

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

offset: number
Tham số tùy chọn cho phân trang. Mặc định: 0
ví dụ: 0

limit: number
Tham số tùy chọn cho phân trang. Mặc định: 30
ví dụ: 30

Mặc định, bạn có thể truy xuất 10 đối tượng. Điều này là do giới hạn bản ghi trong cài đặt quyền của mô-đun.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền mô-đun theo nhu cầu của bạn trong phần tương ứng.

Ví dụ

Ví dụ tối thiểu

const response = await Orders.getAllOrdersStorage();

Ví dụ với các thuộc tính

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IOrdersEntity[]

id: number
Định danh đối tượng.
ví dụ: 1

localizeInfos: ILocalizeInfo
Tên theo ngữ cảnh địa phương hóa.
ví dụ:

{
  "title": "Cash"
}

position: number | null
Vị trí trong lưu trữ đơn hàng.
ví dụ: 1

identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "order_storage_1"

formIdentifier: string
Định danh văn bản cho biểu mẫu được sử dụng bởi lưu trữ đơn hàng.
ví dụ: "bar-orders-form"

generalTypeId: number | null
Định danh loại.
ví dụ: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Mảng các định danh văn bản của các tài khoản thanh toán được sử dụng bởi lưu trữ đơn hàng.
ví dụ:

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

paymentAccountIdentifiers.identifier: string
Định danh văn bản của tài khoản thanh toán.
ví dụ: "payment-1"

---