getAllOrdersStorage

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

Orders.getAllOrdersStorage(langCode, offset, limit)

const value = await Orders.getAllOrdersStorage()

Схема

langCode: number
Необязательное поле языка
пример: en_US

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

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

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

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

[
  {
    "id": 1764,
    "localizeInfos": {
        "title": "Заказ 1"
    },
    "identifier": "catalog",
    "generalTypeId": 4,
    "formIdentifier": "catalog-form",
    "paymentAccountIdentifiers": [
      {
        "identifier": "p1"
      }
    ]
  }
]

Схема

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

localizeInfos: Record<string, any>
json-описание основного объекта данных страницы с учетом языка "en_US" (например)
пример:

{
  "en_US": {
    "title": "Каталог",
    "plainContent": "Содержимое для каталога",
    "htmlContent": "<b>Содержимое для каталога</b>",
    "menuTitle": "Каталог"
  }
}

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

generalTypeId number
идентификатор типа
пример: 4

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

paymentAccountIdentifiers Array<{ identifier: string }
массив текстовых идентификаторов платежных счетов, используемых в хранении заказов
пример:

[
  {
    "identifier": "p1"
  }
]

---