getAllOrdersByMarker

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

Описание

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

Orders.getAllOrdersByMarker(

marker, langCode, offset, limit

);

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

Схема

marker(обязательно): string
Текстовый идентификатор объекта хранения заказов
пример: "order_storage_1"

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

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

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

Примеры

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

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

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

const response = await Orders.getAllOrdersByMarker('my-order', 'en_US', 0, 30);

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

{
  "items": [
    {
      "id": 233,
      "storageId": 1,
      "createdDate": "2025-07-21T09:40:08.552Z",
      "statusIdentifier": "inProgress",
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Иван",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "totalSum": "300.00",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Наличные"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2
        }
      ],
      "isCompleted": false
    },
    {
      "id": 232,
      "storageId": 1,
      "createdDate": "2025-07-21T01:54:32.065Z",
      "statusIdentifier": "inProgress",
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Иван",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "totalSum": "300.00",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Наличные"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2
        }
      ],
      "isCompleted": false
    },
    {
      "id": 231,
      "storageId": 1,
      "createdDate": "2025-07-21T01:49:51.641Z",
      "statusIdentifier": "inProgress",
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Иван",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "totalSum": "300.00",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Наличные"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2
        }
      ],
      "isCompleted": false
    },
    "..."
  ],
  "total": 40
}

Схема ответа

Схема: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Массив объектов хранения заказов.
пример:

[
  {
    "id": 55,
    "storageId": 1,
    "createdDate": "2025-03-22T21:12:42.371Z",
    "statusIdentifier": "inProgress",
    "formIdentifier": "orderForm",
    "formData": [
      {
        "marker": "order_name",
        "value": "Иван",
        "type": "string"
      }
    ],
    "attributeSetIdentifier": "order_form",
    "totalSum": "300.00",
    "currency": "",
    "paymentAccountIdentifier": "cash",
    "paymentAccountLocalizeInfos": {
      "title": "Наличные"
    },
    "products": [
      {
        "id": 2957,
        "title": "Cosmo",
        "sku": null,
        "previewImage": null,
        "price": 150,
        "quantity": 2
      }
    ],
    "isCompleted": false
  }
]

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

---