getAllOrdersStorage

Récupération de tous les objets de stockage de commandes. 🔐 Cette méthode nécessite l'autorisation?.

Orders?.getAllOrdersStorage( langCode?, offset?, limit? );

Exemple minimal

const value = await Orders.getAllOrdersStorage()

Schéma

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

offset: number
Paramètre optionnel pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre optionnel pour la pagination. Par défaut : 30
exemple : 30

Cette méthode récupère tous les objets de stockage de commandes. La méthode ajoutera la langue par défaut au corps de la requête. Si vous souhaitez changer la langue, il vous suffit de la passer en tant que deuxième argument.

Exemple de réponse

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "Ma commande"
    },
    "position": 1,
    "identifier": "ma_commande",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "cash"
      },
      {
        "identifier": "stripe"
      }
    ]
  }
]

Schéma

id: number
Identifiant de l'objet.
exemple : 1

localizeInfos: ILocalizeInfo
Nom tenant compte de la localisation.
exemple :

{
  "title": "Espèces"
}

position: number | null
Position dans le stockage des commandes.
exemple : 1

identifier: string
Identifiant textuel pour le champ d'enregistrement.
exemple : "order_storage_1"

formIdentifier: string
Identifiant textuel pour le formulaire utilisé par le stockage des commandes.
exemple : "bar-orders-form"

generalTypeId: number | null
Identifiant de type.
exemple : 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Tableau d'identifiants textuels des comptes de paiement utilisés par le stockage des commandes.
exemple :

[
  {
    "identifier": "payment-1"
  }
]

---