getICollections

Obteniendo todas las colecciones.

Descripción

Devuelve una Promesa que se resuelve en un objeto ICollectionEntity.

IntegrationCollections.getICollections(

langCode, userQuery

);

Esquema de parámetros

Esquema

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

userQuery: object
Parámetros de consulta opcionales
ejemplo:

{
  "limit": 0,
  "offset": 30,
  "entityType": "orders",
  "entityId": 1
}

Ejemplos

Ejemplo mínimo

const result = await IntegrationCollections.getICollections();

Ejemplo con atributos

const userQuery = '';
const result = await IntegrationCollections.getICollections('en_US', userQuery);

Ejemplo de respuesta

[
  {
    "id": 1,
    "identifier": "test_collection",
    "formId": 2,
    "localizeInfos": {
      "title": "texto de prueba_colección"
    },
    "attributeSetId": null,
    "selectedAttributeMarkers": null
  }
]

Esquema de respuesta

Esquema: ICollectionEntity[]

id: number
Identificador del objeto.
ejemplo: 1

identifier: string | null
Identificador de texto para el campo del registro.
ejemplo: "colección1"

formId: number | null
Identificador del formulario utilizado por el almacenamiento de pedidos.
ejemplo: 1234

localizeInfos: ILocalizeInfo
Información localizada sobre la colección.
ejemplo:

{
  "title": "Texto de Admins"
}

attributeSetId: string | null
Identificador del conjunto de atributos utilizados por el formulario adjunto a la colección.
ejemplo: "attributeSet1" o null si no aplica

selectedAttributeMarkers: string | null
Identificadores de texto de los atributos del objeto del formulario para mostrar en la tabla de datos.
ejemplo: "marcador_colección"

---