getOrderByMarkerAndId

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

Описание

Этот метод извлекает один объект хранения заказа по маркеру и идентификатору. Он возвращает Promise, который разрешается в объект IOrderByMarkerEntity.

Orders.getOrderByMarkerAndId(

marker, id, langCode

);

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

Схема

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

id(обязательно): number
ID объекта заказа
пример: 12345

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

Примеры

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

const response = await Orders.getOrderByMarkerAndId('my-order', 1764);

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

const response = await Orders.getOrderByMarkerAndId('my-order', 1764, 'en_US');

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

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "Иван"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "totalSum": "50.00",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Коробка",
      "sku": null,
      "previewImage": null,
      "price": 50,
      "quantity": 1
    }
  ],
  "isCompleted": false
}

Схема ответа

Схема: IOrderByMarkerEntity

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

storageId: number
Идентификатор объекта хранения заказа.
пример: 1

createdDate: string
Дата создания заказа.
пример: "2023-10-01T12:00:00Z"

statusIdentifier: string
Текстовый идентификатор статуса заказа.
пример: "order-status-1"

formIdentifier: string
Текстовый идентификатор формы.
пример: "bar-orders-form"

formData: IOrdersFormData[]
Данные, отправленные формой, связанной с хранилищем заказов.
пример:

[
  {
    "marker": "order_name",
    "value": "Иван",
    "type": "string"
  }
]

attributeSetIdentifier: string | null
Текстовый идентификатор набора атрибутов.
пример: "attribute-set-1"

totalSum: string
Общая сумма заказа.
пример: "100.00"

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

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

paymentAccountLocalizeInfos: Record<string, any>
Название платежного аккаунта с учетом локализации.
пример:

{
  "en_US": "USD Payment",
  "ru_RU": "Оплата в долларах США"
}

products: IOrderProducts[]
Массив продуктов, добавленных в заказ.
пример:

[
  {
    "id": 1,
    "name": "Продукт 1",
    "quantity": 2
  }
]

isCompleted: boolean
Указывает, что заказ завершен.
пример: true

---