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

getOrderByMarker

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

Orders.getOrderByMarker(marker, langCode)

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

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

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

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

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

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

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

localizeInfos: Record<string, any>
json-описание объекта данных главной страницы с учетом языка "en_US" (например)
пример:

{
"en_US": {
"title": "Каталог",
"plainContent": "Содержимое для каталога",
"htmlContent": "<b>Содержимое для каталога</b>",
"menuTitle": "Каталог"
}
}

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

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

formIdentifier строка
текстовый идентификатор для формы, используемой объектом хранения заказа
пример: catalog-form

paymentAccountIdentifiers Array<{identifier:string}
массив текстовых идентификаторов платежных счетов, используемых объектом хранения заказа
пример:

[
{
"identifier": "p1"
}
]