getOrderById

Récupérer une seule commande créée par l'utilisateur, par son propre identifiant.

Description

Cette méthode récupère une commande de l'utilisateur authentifié uniquement par l'identifiant de la commande, sans le marqueur de stockage. Elle renvoie une promesse qui se résout en un objet IOrderByMarkerEntity - la même entité que celle renvoyée par getOrderByMarkerAndId.

Commandes.getOrderById(id, langCode);

Paramètres

id: number
ID de l'objet commande.
exemple : 12345

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

💡 Quand l'utiliser à la place de getOrderByMarkerAndId

getOrderByMarkerAndId nécessite à la fois le marqueur de stockage et l'identifiant. Le marqueur est exactement ce qui manque lorsque l'identifiant provient de l'extérieur de votre application : l'URL de retour d'un fournisseur de paiement, un lien dans une notification, un numéro de commande qu'un client lit au téléphone. Dans ces cas, utilisez cette méthode.

🔐 Autorisation

Cette méthode nécessite une autorisation utilisateur. Voir le module AuthProvider.

Exemples

Exemple minimal

const response = await Orders.getOrderById(205);

Avec un code de langue

const response = await Orders.getOrderById(205, 'en_US');

Exemple de réponse

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "statusLocalizeInfos": {
    "title": "In progress"
  },
  "fulfillmentStatusIdentifier": null,
  "fulfillmentStatusLocalizeInfos": null,
  "paymentStatusIdentifier": null,
  "paymentStatusLocalizeInfos": null,
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "paymentStrategy": "once",
  "totalSum": "51",
  "totalSumRaw": "51",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Box",
      "sku": null,
      "previewImage": [
        {
          "size": 742690,
          "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
          "contentType": "image/jpeg",
          "previewLink": {
            "default": [
              "data:image/webp;base64,UklGRmwAAABXRUJQVlA4IGAAAADQAQCdASoQABAABUB8JbACdACZZ3P8AAD+wGsUXBs/r069WpdrcuaTNfVxqWIetuaIdIvOMkSp9iJRxE+KhA2YHbrVehhMRj/j5+DUdjWn1v5YtZ7vw0IgPi9R5vkAAAA=",
              "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.preview.default.jpeg"
            ]
          },
          "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
          "defaultPreview": "default"
        }
      ],
      "price": 51,
      "quantity": 1,
      "isGift": false
    }
  ],
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a19RuP9hh4gGmaSOQwb57OBpnypIifa0FDnGhYe7od5XkRXRUpYXUKDRtm#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl",
  "discountConfig": {
    "orderDiscounts": [],
    "productDiscounts": [],
    "coupon": null,
    "settings": {
      "allowStacking": false,
      "maxDiscountValue": null,
      "allowGiftStacking": false
    },
    "additionalDiscountsMarkers": [],
    "totalRaw": 51,
    "totalSumWithDiscount": 51,
    "excludedGiftProductIds": [],
    "bonus": null,
    "bonusApplied": 0,
    "totalDue": 51
  },
  "isPartial": false,
  "isCompleted": false,
  "split": {
    "completed": false,
    "partial": false,
    "stages": [
      {
        "marker": "default",
        "sessionId": null,
        "productId": 2954,
        "title": "Default",
        "value": 51,
        "status": "planned"
      }
    ]
  }
}

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 la 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 la commande.
exemple :

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

formData.marker: string
Marqueur du champ de formulaire.
exemple : "name_1"

formData.type: string
Type de valeur.
exemple : "string"

formData.value: string
Valeur.
exemple : "Nom"

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

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

totalSumRaw: string
Montant total brut de la commande avec pleine précision.
exemple : "100.00"

currency: string
Devise utilisée pour payer la commande.
exemple : "USD"

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

paymentAccountLocalizeInfos: ILocalizeInfo
Nom du compte de paiement en tenant compte de la localisation.
exemple :

{
  "title": "Cash"
}

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

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

products.id: number
ID du produit.
exemple : 2957

products.quantity: number
Quantité de produit.
exemple : 1

products.title: string
Titre du produit.
exemple : "Cosmo"

products.sku: string | null
SKU du produit.
exemple : "SKU"

products.previewImage: IPicture | null
Image de prévisualisation du produit.
exemple :

{
  "filename": "image.jpg",
  "downloadLink": "https://example.com/image.jpg",
  "size": 102400,
  "previewLink": "https://example.com/image-preview.jpg"
}

products.price: number
Prix du produit.
exemple : 150

products.isGift: boolean
Indique si le produit est un cadeau.
exemple : false

paymentUrl: string | null
Lien de paiement.
exemple : "https://example.com/pay/123"

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

isPartial: boolean | null
Indique que la commande est partiellement payée ; null pour les anciennes commandes où cela n'était pas suivi.
exemple : false

paymentStrategy: string
Stratégie de paiement de la commande.
exemple : "once"

statusLocalizeInfos: ILocalizeInfo
Nom de statut localisé.

fulfillmentStatusIdentifier: string | null
Identifiant textuel du statut d'exécution (livraison) ; null tant qu'aucun statut d'exécution n'est attribué.
exemple : "shipped"

fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nom de statut d'exécution localisé ; null tant qu'aucun statut d'exécution n'est attribué.

paymentStatusIdentifier: string | null
Identifiant textuel du statut de paiement ; null tant qu'aucun statut de paiement n'est attribué.
exemple : "inProgress-payment"

paymentStatusLocalizeInfos: ILocalizeInfo | null
Nom de statut de paiement localisé ; null tant qu'aucun statut de paiement n'est attribué.

discountConfig: IOrderDiscountConfig | null
Configuration de remise résolue appliquée à la commande (orderDiscounts, productDiscounts, coupon, settings, bonus, totals) ; null pour les anciennes commandes sans configuration de remise résolue.

discountConfig.bonus: IOrderDiscountBonus | null
Résultat du calcul de bonus, null lorsque les bonus ne sont pas utilisés, ou omis entièrement lorsque la commande n'a pas de contexte de bonus.

discountConfig.coupon: unknown | null
Coupon résolu, ou null lorsque aucun coupon n'est appliqué.

discountConfig.orderDiscounts: unknown[]
Remises au niveau de la commande qui ont été correspondantes et appliquées.

discountConfig.productDiscounts: unknown[]
Remises au niveau du produit qui ont été correspondantes et appliquées.

discountConfig.settings: IOrderDiscountSettings
Paramètres d'accumulation et de plafond utilisés lors du calcul.

discountConfig.additionalDiscountsMarkers: string[]
Marqueurs de remises supplémentaires demandées par le client (omis dans les réponses de prévisualisation).

discountConfig.bonusApplied: number
Montant de bonus appliqué à la commande (omis dans les réponses de prévisualisation).
exemple : 0

discountConfig.excludedGiftProductIds: string[]
IDs de produits exclus de la sélection de cadeaux (omis dans les réponses de prévisualisation).

discountConfig.totalDue: number
Montant total dû après remises et bonus (omis dans les réponses de prévisualisation).
exemple : 300

discountConfig.totalRaw: number
Montant total avant remises (omis dans les réponses de prévisualisation).
exemple : 300

discountConfig.totalSumWithDiscount: number
Montant total après remises mais avant bonus (omis dans les réponses de prévisualisation).
exemple : 300

split: IOrderSplit
Configuration de paiement fractionné (étagé) ; présente sur le point de terminaison de commande par ID.

split.completed: boolean
Indique si toutes les étapes fractionnées sont complètes.
exemple : false

split.partial: boolean
Indique si le fractionnement est partiellement payé.
exemple : false

split.stages: IOrderSplitStage[]
Liste ordonnée des étapes de paiement fractionné.

distance: number
Distance cosinus par rapport à la requête. Renvoie uniquement par le point de terminaison de recherche sémantique (vectorielle) lorsque debug: true est passé dans le corps de la recherche.
exemple : 0.12

Description​

Paramètres​

💡 Quand l'utiliser à la place de getOrderByMarkerAndId​

🔐 Autorisation​

Exemples​

Exemple minimal​

Avec un code de langue​

Exemple de réponse​

Schéma de réponse​