getOrderByMarker

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

Описание

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

Orders.getOrderByMarker(

marker, langCode

);

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

Схема

marker(обязательный): string
Маркер объекта заказа
пример: "order_storage_1"

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

Примеры

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

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

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

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

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

{
  "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"
  }
]

---