createICollectionRow

Создайте запись в коллекции.

Описание

Возвращает Promise, который разрешается в объект ICollectionRow.

IntegrationCollections.createICollectionRow(

marker, body, body.formIdentifier, body.formData, langCode

);

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

Схема

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

body(обязательно): ICollectionFormObject
Объект для создания записи
пример:

{
  "formIdentifier": "collection-form",
  "formData": {
    "en_US": [
      {
        "marker": "collection_marker",
        "type": "string",
        "value": "Маркер коллекции"
      }
    ]
  }
}

body.formIdentifier(обязательно): string
Текстовый идентификатор (маркер) формы.
пример: "collection-form"

body.formData(обязательно): Record<string, ICollectionFormData>
Объект, где ключи — это маркеры полей формы, а значения — массивы объектов ICollectionFormData.
пример:

[
  {
    "marker": "name_1",
    "type": "string",
    "value": "Значение"
  }
]

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

Примеры

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

const body = {
"formIdentifier": "collection-form",
"formData": [
{
"marker": "name_1",
"type": "string"
"value": "Значение"
}
]
};
const response = await IntegrationCollections.createICollectionRow(body);

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

{
  "formData": [
    {
      "marker": "c_marker",
      "type": "string",
      "value": "Значение"
    }
  ],
  "collectionId": 1,
  "langCode": "en_US",
  "createdDate": "2025-07-21T09:40:07.591Z",
  "updatedDate": "2025-07-21T09:40:07.591Z",
  "entityType": null,
  "entityId": null,
  "id": 414
}

Схема ответа

Схема: ICollectionRow

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

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

updatedDate: string
Дата последнего обновления записи.
пример: "2023-01-02T00:00:00Z"

collectionId: number | null
collectionId, связанный с записью коллекции.
пример: "product", "order", "и т.д."

formData: ICollectionFormData[]
Массив объектов данных формы, связанных с записью коллекции.
пример:

[
  {
    "marker": "name_1",
    "type": "string",
    "value": "Значение"
  }
]

entityType: string | null
Тип сущности, связанной с записью коллекции.
пример: "product", "order", "и т.д."

entityId: number | null
Идентификатор сущности, связанной с записью коллекции.
пример: 12345

attributeSetIdentifier: string | null
Идентификатор набора атрибутов, используемого формой, прикрепленной к записи коллекции, или null, если не применимо.
пример: "attributeSet1" или null

total: string
Общее количество.
пример: "1"

---