getAllStatusesByStorageMarker

Récupération de tous les statuts de commande disponibles pour un stockage de commande spécifique par son marqueur.

Description

Cette méthode récupère tous les objets de statut de commande associés à un stockage de commande spécifique, identifié par son marqueur textuel. Elle renvoie une promesse qui se résout en un tableau d'objets IOrderStatusEntity.

Orders.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

Parameters schema

Schema

marker(obligatoire) : string
Identifiant textuel de l'objet de stockage de commande
exemple : "order_storage_1"

langCode : string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

offset : number
Paramètre d'offset. Par défaut : 0
exemple : 0

limit : number
Paramètre de limite. Par défaut : 30
exemple : 30

Examples

Minimal example

const response = await Orders.getAllStatusesByStorageMarker('my_order');

Example with attributes

const response = await Orders.getAllStatusesByStorageMarker('my_order', 'en_US');

Example response

[
  {
    "id": 1,
    "identifier": "inProgress",
    "localizeInfos": {
      "title": "In Progress"
    },
    "isDefault": true,
    "position": 1
  },
  {
    "id": 2,
    "identifier": "completed",
    "localizeInfos": {
      "title": "Completed"
    },
    "isDefault": false,
    "position": 2
  },
  {
    "id": 3,
    "identifier": "cancelled",
    "localizeInfos": {
      "title": "Cancelled"
    },
    "isDefault": false,
    "position": 3
  }
]

Response schema

Schema: IOrderStatusEntity[]

id : number
Identifiant du statut.
exemple : 1

localizeInfos : object
Informations localisées pour le statut.

identifier : string
Identifiant textuel du statut.
exemple : "inProgress"

position : Record<string, unknown>
Position du statut.

isUsed : boolean
Indique si le statut est utilisé.
exemple : true

---