Aller au contenu principal

getAllStatusesByStorageMarker

Récupère tous les statuts de commande disponibles dans un stockage de commandes. 🔐 Cette méthode nécessite une autorisation.

Description​

Récupère les statuts de commande définis dans le stockage portant le marqueur indiqué. Renvoie un tableau d'objets IOrderStatus.

.getAllStatusesByStorageMarker(

, , ,

);

Schéma des paramètres​

Schema

marker(required): string
Marqueur du stockage des commandes.
exemple : "order_storage_1"

langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

offset: number
Nombre d'enregistrements à ignorer. Par défaut : 0. offset + limit ne doit pas dépasser 200 ; une fenêtre plus grande est rejetée avec 400.
exemple : 0

limit: number
Nombre maximal d'enregistrements à renvoyer. Par défaut : 30.
exemple : 30

Exemples​

Exemple minimal​

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

Exemple avec langCode​

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​

Schema: IOrderStatus[]

id: number
ID du statut.
exemple : 1

localizeInfos: ILocalizeInfo
Données localisées du statut.

identifier: string
Marqueur du statut.
exemple : "inProgress-payment"

position: number
Position du statut, utilisée pour le tri.
exemple : 1

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

isDefault: boolean
Indique s'il s'agit du 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 final d'annulation.
exemple : false

isFinalSuccess: boolean
Indique si le statut est un statut final de réussite.
exemple : true

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