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

);

Schéma des paramètres

Schéma

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

Exemples

Exemple minimal

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

Exemple avec des attributs

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

Exemple de réponse

[
  {
    "id": 9,
    "identifier": "completed-payment",
    "localizeInfos": {
      "title": "Completed"
    },
    "isDefault": false,
    "isCancelFinal": false,
    "isFinalSuccess": true,
    "axis": "payment",
    "position": 1,
    "isUsed": false,
    "isMapped": true
  },
  {
    "id": 7,
    "identifier": "inProgress-payment",
    "localizeInfos": {
      "title": "In progress"
    },
    "isDefault": true,
    "isCancelFinal": false,
    "isFinalSuccess": false,
    "axis": "payment",
    "position": 2,
    "isUsed": true,
    "isMapped": true
  },
  {
    "id": 11,
    "identifier": "expired-payment",
    "localizeInfos": {
      "title": "Expired"
    },
    "isDefault": false,
    "isCancelFinal": false,
    "isFinalSuccess": false,
    "axis": "payment",
    "position": 3,
    "isUsed": false,
    "isMapped": true
  },
  "..."
]

Schéma de réponse

Schéma : IOrderStatusEntity[]

id: number
Identifiant du statut.
exemple : 1

localizeInfos: ILocalizeInfo
Informations localisées pour le statut.

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

position: number
Position du statut.
exemple : 1

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

isDefault: boolean
Indique si le statut est le statut par défaut.
exemple : true

axis: string
Axe de statut (pipeline) auquel appartient le statut.
exemple : "payment"

isCancelFinal: boolean
Indique si le statut est un statut d'annulation final.
exemple : false

isFinalSuccess: boolean
Indique si le statut est un statut de succès final.
exemple : true

isMapped: boolean
Indique si le statut est mappé à son axe.
exemple : true

---