Saltar al contenido principal

getProductsByStatusMarker

Busca un objeto de estado de producto por su identificador textual (marcador).

Descripción​

Este método busca un objeto de estado de producto basado en su identificador textual (marcador) desde la API. Devuelve una Promesa que se resuelve en un objeto de estado de producto IProductStatusEntity.

ProductStatuses.getProductsByStatusMarker(

marker*, langCode

);

Esquema de parámetros​

Esquema

marker(requerido): string
Marcador del producto
ejemplo: "in_stock"

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

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con atributos​

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

Ejemplo de respuesta​

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

Esquema de respuesta​

Esquema: IProductStatusEntity

id: number
El identificador único de la posición.
ejemplo: 12345

identifier: string
El identificador textual para el campo del registro.
ejemplo: "in_stock"

localizeInfos: ILocalizeInfo
El nombre de los estados de los productos, teniendo en cuenta la localización.
ejemplo:

{
  "title": "Catálogo",
  "plainContent": "Contenido para el catálogo",
  "htmlContent": "<b>Contenido para el catálogo</b>",
  "menuTitle": "Catálogo"
}

isDefault: boolean
Indicador de estado por defecto.
ejemplo: true

version: number
El número de versión del objeto.
ejemplo: 1

position: number
Número de posición.
ejemplo: 1