Aller au contenu principal

getAllOrdersStorage

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

Description​

Cette méthode récupère tous les objets de stockage de commandes configurés pour le projet, avec pagination. Elle renvoie une Promesse qui se résout en un tableau d'objets IOrdersEntity.

.getAllOrdersStorage(

, ,

);

Schéma des paramètres​

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

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer les permissions du module selon vos besoins dans la section correspondante.

Exemples​

Exemple minimal​

const response = await Orders.getAllOrdersStorage();

Exemple avec des attributs​

const response = await Orders.getAllOrdersStorage('en_US', 0, 30);

Exemple de réponse​

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "My order"
    },
    "position": 1,
    "identifier": "my_order",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "stripe"
      },
      {
        "identifier": "cash"
      },
      {
        "identifier": "paypal"
      }
    ]
  }
]

Schéma de réponse​

Schéma : IOrdersEntity[]

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

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

{
  "title": "Cash"
}

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 de 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 de commandes.
exemple :

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

paymentAccountIdentifiers.identifier: string
Identifiant textuel du compte de paiement.
exemple : "payment-1"