Pular para o conteúdo principal

getProductsByStatusMarker

Pesquise um objeto de status de produto pelo seu identificador textual (marcador).

Descrição​

Este método busca um objeto de status de produto com base em seu identificador textual (marcador) da API. Ele retorna uma Promise que resolve para um objeto de status de produto IProductStatusEntity.

ProductStatuses.getProductsByStatusMarker(

marker*, langCode

);

Esquema de parâmetros​

Esquema

marker(obrigatório): string
Marcador do produto
exemplo: "in_stock"

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

Exemplos​

Exemplo mínimo​

const response = await ProductStatuses.getProductsByStatusMarker('my-marker');

Exemplo com atributos​

const response = await ProductStatuses.getProductsByStatusMarker('my-marker', 'en_US');

Exemplo de resposta​

{
  "id": 2,
  "identifier": "sold",
  "localizeInfos": {
    "title": "Vendido"
  },
  "version": 0,
  "isDefault": false,
  "position": 1
}

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