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. Padrão: "en_US"
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": 2,
    "identifier": "sold",
    "localizeInfos": {
      "title": "Vendido"
    },
    "isDefault": false,
    "version": 0,
    "position": 1
  },
  {
    "id": 1,
    "identifier": "sale",
    "localizeInfos": {
      "title": "Venda"
    },
    "isDefault": true,
    "version": 0,
    "position": 2
  }
]

Esquema de resposta​

Esquema: IProductStatusEntity[]

id: number
O identificador único da posição.
exemplo: 12345

identifier: string
O identificador textual para o campo do registro.
exemplo: "in_stock"

localizeInfos: ILocalizeInfo
O nome dos status dos produtos, levando em conta a localização.
exemplo:

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

isDefault: boolean
Flag de status padrão.
exemplo: true

version: number
O número da versão do objeto.
exemplo: 1

position: number
Número da posição.
exemplo: 1