Перейти к основному содержимому

getOrderByMarker

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

Orders.getOrderByMarker(marker, langCode)

const value = await Orders.getOrderByMarker('my-order')
Схема

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

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

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

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

{
"id": 1,
"localizeInfos": {
"title": "Мой заказ"
},
"position": 1,
"identifier": "my_order",
"formIdentifier": "orderForm",
"generalTypeId": 21,
"paymentAccountIdentifiers": [
{
"identifier": "cash"
},
{
"identifier": "stripe"
}
]
}
Схема

id: число
Идентификатор объекта.
пример: 1

localizeInfos: ILocalizeInfo
Название с учетом локализации.
пример:

{
"title": "Наличные"
}

identifier: строка
Текстовый идентификатор для поля записи.
пример: "order_storage_1"

generalTypeId: число
Идентификатор типа.
пример: 1

formIdentifier: строка
Текстовый идентификатор для формы, используемой хранилищем заказов.
пример: "bar-orders-form"

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Массив текстовых идентификаторов платежных счетов, используемых хранилищем заказов.
пример:

[
{
"identifier": "payment-1"
}
]

position: число
Позиция в хранилище заказов.
пример: 1