Pular para o conteúdo principal

getProductStatuses

Pesquise por todos os objetos de status de produto.

Descrição​

Este método pesquisa todos os objetos de status de produto da API. Ele retorna uma Promise que resolve para um array de objetos de status de produto IProductStatusEntity.

ProductStatuses.getProductStatuses(

langCode

);

Esquema de parâmetros​

Esquema

langCode: string
código do idioma
exemplo: en_US

Exemplos​

Exemplo mínimo​

const response = await ProductStatuses.getProductStatuses();

Exemplo com atributos​

const response = await ProductStatuses.getProductStatuses('en_US');

Exemplo de resposta​

[
  {
    "id": 1,
    "identifier": "sale",
    "localizeInfos": {
      "title": "Venda"
    },
    "isDefault": true,
    "version": 0,
    "position": 1
  },
  {
    "id": 2,
    "identifier": "sold",
    "localizeInfos": {
      "title": "Vendido"
    },
    "isDefault": false,
    "version": 0,
    "position": 2
  }
]

Esquema de resposta​

Esquema: IProductStatusEntity[]

id: number
identificador do objeto
exemplo: 1764

version number
número da versão do objeto de modificação
exemplo: 10

identifier: string
identificador textual para um campo no registro
exemplo: catalog

localizeInfos: Record<string, any>
descrição em json do objeto de dados da página principal levando em conta o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}