getICollections

Obtendo todas as coleções.

Descrição

Retorna uma Promise que resolve para um objeto ICollectionEntity.

IntegrationCollections.getICollections(

langCode, userQuery

);

Esquema de parâmetros

Esquema

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

userQuery: object
Conjunto de parâmetros de consulta opcionais
exemplo:

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

Exemplos

Exemplo mínimo

const result = await IntegrationCollections.getICollections();

Exemplo com atributos

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

Exemplo de resposta

[
  {
    "id": 1,
    "identifier": "test_collection",
    "formId": 2,
    "localizeInfos": {
      "title": "texto_test_collection"
    },
    "attributeSetId": null,
    "selectedAttributeMarkers": null
  }
]

Esquema de resposta

Esquema: ICollectionEntity[]

id: number
Identificador do objeto.
exemplo: 1

identifier: string | null
Identificador de texto para o campo do registro.
exemplo: "collection1"

formId: number | null
Identificador do formulário usado pelo armazenamento de pedidos.
exemplo: 1234

localizeInfos: ILocalizeInfo
Informações localizadas sobre a coleção.
exemplo:

{
  "title": "Texto dos Admins"
}

attributeSetId: string | null
Identificador do conjunto de atributos usados pelo formulário anexado à coleção.
exemplo: "attributeSet1" ou null se não aplicável

selectedAttributeMarkers: string | null
Identificadores de texto dos atributos do objeto do formulário para exibição na tabela de dados.
exemplo: "collection_marker"

---