Aller au contenu principal

getOrdersStorageByMarker

Récupère un stockage de commandes par son marqueur. 🔐 Cette méthode nécessite une autorisation.

Description​

Récupère un stockage de commandes par son marqueur. Renvoie un IOrdersEntity.

.getOrdersStorageByMarker(

,

);

Schéma des paramètres​

Schema

marker(obligatoire): 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"

Exemples​

Exemple minimal​

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

Exemple avec langCode​

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

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
ID de l'objet.
exemple : 1

localizeInfos: ILocalizeInfo
Nom localisé du stockage des commandes.
exemple :

{
  "title": "Cash"
}

position: number | null
Position du stockage des commandes, utilisée pour le tri.
exemple : 1

identifier: string
Marqueur du stockage des commandes.
exemple : "order_storage_1"

formIdentifier: string
Marqueur du formulaire utilisé par le stockage des commandes.
exemple : "bar-orders-form"

generalTypeId: number | null
ID du type général.
exemple : 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Marqueurs des comptes de paiement utilisés par le stockage des commandes.
exemple :

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

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