getOrderByMarkerAndId

Récupérer une commande par marqueur et identifiant à partir de l'objet de stockage des commandes créé par l'utilisateur. 🔐 Cette méthode nécessite l'autorisation.

Description

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

Orders.getOrderByMarkerAndId(

marker, id, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire): string
L'identifiant textuel de l'objet de stockage de commande
exemple : "order_storage_1"

id(obligatoire): number
ID de l'objet de commande
exemple : 12345

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

Exemples

Exemple minimal

const response = await Orders.getOrderByMarkerAndId('my-order', 1764);

Exemple avec des attributs

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

Exemple de réponse

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "totalSum": "50.00",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Box",
      "sku": null,
      "previewImage": null,
      "price": 50,
      "quantity": 1
    }
  ],
  "isCompleted": false
}

Schéma de réponse

Schéma : IOrderByMarkerEntity

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

storageId: number
Identifiant de l'objet de stockage de commande.
exemple : 1

createdDate: string
Date à laquelle la commande a été créée.
exemple : "2023-10-01T12:00:00Z"

statusIdentifier: string
Identifiant textuel du statut de la commande.
exemple : "order-status-1"

formIdentifier: string
Identifiant textuel du formulaire.
exemple : "bar-orders-form"

formData: IOrdersFormData[]
Données soumises par le formulaire lié au stockage de commande.
exemple :

[
  {
    "marker": "order_name",
    "value": "Ivan",
    "type": "string"
  }
]

attributeSetIdentifier: string | null
Identifiant textuel de l'ensemble d'attributs.
exemple : "attribute-set-1"

totalSum: string
Montant total de la commande.
exemple : "100.00"

currency: string
Monnaie utilisée pour le paiement de la commande.
exemple : "USD"

paymentAccountIdentifier: string | null
Identifiant textuel pour le paiement de la commande.
exemple : "payment-1"

paymentAccountLocalizeInfos: Record<string, any>
Nom du compte de paiement en tenant compte de la localisation.
exemple :

{
  "en_US": "USD Payment",
  "ru_RU": "Оплата в долларах США"
}

products: IOrderProducts[]
Tableau de produits ajoutés à la commande.
exemple :

[
  {
    "id": 1,
    "name": "Product 1",
    "quantity": 2
  }
]

isCompleted: boolean
Indique que la commande a été complétée.
exemple : true

---