getOrderByMarker

Obtenez un objet de stockage de commande par marqueur. 🔐 Cette méthode nécessite l'autorisation.

Description

Cette méthode récupère un objet de stockage de commande par marqueur. Elle renvoie une promesse qui se résout en un objet IOrdersEntity.

Orders.getOrderByMarker(

marker, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire) : string
Marqueur de l'objet de commande
exemple : "order_storage_1"

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

Exemples

Exemple minimal

const response = await Orders.getOrderByMarker('my-order');

Exemple avec des attributs

const response = await Orders.getOrderByMarker('my-order', 'en_US');

Exemple de réponse

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

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": "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 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"
  }
]

---