Skip to main content

getProductsByStatusMarker

Search for a product status object by its textual identifier (marker).

Description​

This method searches for a product status object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a product status object IProductStatusEntity.

ProductStatuses.getProductsByStatusMarker(

marker*, langCode

);

Parameters schema​

Schema

marker:* string
Product marker
example: my-marker

langCode: string
language code
example: en_US

Examples​

Minimal example​

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

Example with attributes​

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

Example response​

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

Response schema​

Schema: IProductStatusEntity

id: number
object identifier
example: 1764

version number
object's version number of modification
example: 10

identifier: string
textual identifier for a field in the record
example: catalog

localizeInfos: Record<string, any>
json description of the main page data object taking into account the language "en_US" (for example)
example:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Content for catalog",
    "htmlContent": "<b>Content for catalog</b>",
    "menuTitle": "Catalog"
  }
}