getOrderByMarkerAndId

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

Orders.getOrderByMarkerAndId(marker, id, langCode)

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

Схема

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

id:* число
ID объекта заказа
пример: 1764

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

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

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

{
  "id": 1764,
  "statusIdentifier": "inprogress",
  "formIdentifier": "order-form",
  "formData": [
    {
      "marker": "name_1",
      "type": "string",
      "value": "Имя"
    }
  ],
  "products": [
    {
      "id": 1,
      "title": "Ламинат Floorwood Maxima, 9811 Дуб Мистраль",
      "sku": null,
      "price": "1.00",
      "quantity": 10,
      "previewImage": [
        {
          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
          "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
          "size": 296391,
          "previewLink": ""
        }
      ]
    }
  ],
  "totalSum": "12.00",
  "currency": "USD",
  "createdDate": "2023-01-01 12:12",
  "paymentAccountIdentifier": "payment-1",
  "paymentAccountLocalizeInfos": {
    "en_US": {
      "title": "Счет 1"
    }
  },
  "isHistory": true
}

Схема

id: число
идентификатор объекта
пример: 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"
  }
]