getAllOrdersStorage

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

Описание

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

Orders.getAllOrdersStorage(

langCode, offset, limit

);

Схема параметров

Схема

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

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

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

Примеры

Минимальный пример

const response = await Orders.getAllOrdersStorage();

Пример с атрибутами

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

Пример ответа

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

Схема ответа

Схема: IOrdersEntity[]

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

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

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

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

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

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

generalTypeId: number | null
Идентификатор типа.
пример: 1

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

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

---