getAllOrdersByMarker

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

Orders.getAllOrdersByMarker(marker, langCode, offset, limit)

const value = await Orders.getAllOrdersByMarker('my-order')

Схема

marker:* строка
Текстовый идентификатор объекта хранения заказов
пример: my-order

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

offset: число
Параметр смещения. По умолчанию 0
пример: 0

limit: число
Параметр ограничения. По умолчанию 30
пример: 30

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

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

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "statusIdentifier": "inprogress",
      "formIdentifier": "order-form",
      "formData": [
        {
          "marker": "name_1",
          "type": "string",
          "value": "Name"
        }
      ],
      "products": [
        {
          "id": 1,
          "title": "Ламинат Floorwood Maxima, 9811 Дуб Мистраль",
          "sku": null,
          "price": "1.00",
          "quantity": 10,
          "previewImage": [
            {
              "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
              "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
              "size": 296391,
              "previewLink": ""
            }
          ]
        }
      ],
      "totalSum": "12.00",
      "currency": "USD",
      "createdDate": "2023-01-01 12:12",
      "paymentAccountIdentifier": "payment-1",
      "paymentAccountLocalizeInfos": {"title": "Счет 1"
      },
      "isHistory": true
    }
  ]

}

Схема

total: число
общее количество найденных записей
пример: 100

statusIdentifier: строка
текстовый идентификатор статуса заказа
пример: inprogress

formIdentifier: строка
текстовый идентификатор статуса формы
пример: order-form

formData FormDataType
данные, отправленные формой, связанной с хранилищем заказов
пример:

[
  {
    "marker": "name_1",
    "value": "Name"
  }
]

products Record<string, string | any>[]
массив продуктов, добавленных в заказ

totalSum строка
общая сумма заказа
пример: 12.00

currency строка
валюта, используемая для оплаты заказа
пример: USD

createdDate строка
дата создания заказа
пример: 2023-01-01 12:12

price число
цена продукта за единицу (на момент заказа)
пример: 20.00

paymentAccountIdentifier строка
текстовый идентификатор для оплаты заказа
пример: payment-1

paymentAccountLocalizeInfos CommonLocalizeInfos
название платежного аккаунта с учетом локализации
пример:

{
  "title": "Счет 1"
}

isHistory булево
указывает на то, что заказ был сохранен в истории заказов
пример: true