getAllOrdersStorage

Получение всех объектов хранения заказов 🔐 Этот метод требует авторизации.

Orders.getAllOrdersStorage(langCode, offset, limit)

const value = await Orders.getAllOrdersStorage()

Схема

langCode: строка
Код языка. По умолчанию: "en_US"
пример: "en_US"

offset: число
Необязательный параметр для постраничной навигации. По умолчанию: 0
пример: 0

limit: число
Необязательный параметр для постраничной навигации. По умолчанию: 30
пример: 30

Этот метод получает все объекты хранения заказов. Метод добавит язык по умолчанию в тело запроса. Если вы хотите изменить язык, просто передайте его в качестве второго аргумента.

Пример возвращаемого значения:

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "Мой заказ"
    },
    "position": 1,
    "identifier": "my_order",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "cash"
      },
      {
        "identifier": "stripe"
      }
    ]
  }
]

Схема

id: число
Идентификатор объекта.
пример: 1

localizeInfos: ILocalizeInfo
Название с учетом локализации.
пример:

{
  "title": "Наличные"
}

identifier: строка
Текстовый идентификатор для поля записи.
пример: "order_storage_1"

generalTypeId: число
Идентификатор типа.
пример: 1

formIdentifier: строка
Текстовый идентификатор для формы, используемой хранилищем заказов.
пример: "bar-orders-form"

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Массив текстовых идентификаторов платежных счетов, используемых хранилищем заказов.
пример:

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

position: число
Позиция в хранилище заказов.
пример: 1

---