getOrderByMarker

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

Orders.getOrderByMarker(marker, langCode)

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

Schéma

marker:* chaîne de caractères
L'identifiant textuel de l'objet de stockage de commande
exemple : my-order

langCode: chaîne de caractères
Champ de langue optionnel
exemple : en_US

Cette méthode récupère un objet de stockage de commande par marqueur.

Exemple de retour :

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

Schéma

id: nombre
identifiant de l'objet
exemple : 1764

localizeInfos: Record<string, any>
description json de l'objet de données de la page principale tenant compte de la langue "en_US" (par exemple)
exemple :

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Contenu pour le catalogue",
    "htmlContent": "<b>Contenu pour le catalogue</b>",
    "menuTitle": "Catalogue"
  }
}

identifier chaîne de caractères
identifiant textuel pour le champ d'enregistrement
exemple : catalog

generalTypeId nombre
identifiant de type
exemple : 4

formIdentifier chaîne de caractères
identifiant textuel pour le formulaire utilisé par le stockage de commande
exemple : catalog-form

paymentAccountIdentifiers Array<{identifier:string}
tableau d'identifiants textuels des comptes de paiement utilisés par le stockage de commande
exemple :

[
  {
    "identifier": "p1"
  }
]

.