Aller au contenu principal

getOrderById

Récupère une commande de l'utilisateur par son id. 🔐 Cette méthode nécessite une autorisation.

Description​

Récupère l'une des commandes de l'utilisateur authentifié par son seul id, sans le marqueur du stockage. Renvoie un IOrderByMarkerEntity, la même entité que celle renvoyée par getOrderByMarkerAndId.

.getOrderById(

,

);

Schéma des paramètres​

Schema

id(required): number
ID de la commande.
exemple : 12345

langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Quand l'utiliser à la place de getOrderByMarkerAndId​

getOrderByMarkerAndId a besoin du marqueur du stockage et de l'id. Lorsque l'id vient de l'extérieur de votre application, c'est généralement le marqueur qui vous manque : l'URL de retour d'un prestataire de paiement, un lien dans une notification, un numéro de commande qu'un client dicte au téléphone. Utilisez cette méthode dans ces cas-là.

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": "John"
    }
  ],
  "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
ID de l'objet.
exemple : 125

storageId: number
ID du stockage des commandes.
exemple : 1

createdDate: string
Date de création de la commande.
exemple : "2023-10-01T12:00:00Z"

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

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

formData: IOrdersFormData[]
Données du formulaire lié au stockage des commandes.
exemple :

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

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

formData.type: string
Type de la valeur du champ, par exemple "string".
exemple : "string"

formData.value: string
Valeur du champ.
exemple : "Name"

attributeSetIdentifier: string | null
Marqueur 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 en pleine précision.
exemple : "100.00"

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

paymentAccountIdentifier: string | null
Marqueur du compte de paiement.
exemple : "payment-1"

paymentAccountLocalizeInfos: ILocalizeInfo
Nom localisé du compte de paiement.
exemple :

{
  "title": "Cash"
}

products: IOrderProducts[]
Produits de la commande.
exemple :

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

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

products.quantity: number
Quantité du 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 d'aperçu 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
URL de la page de paiement.
exemple : "https://example.com/pay/123"

isCompleted: boolean | null
Indique si la commande est terminée.
exemple : true

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

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

statusLocalizeInfos: ILocalizeInfo
Nom localisé du statut.

fulfillmentStatusIdentifier: string | null
Marqueur du statut de traitement (livraison) ; null tant qu'aucun statut de traitement n'est attribué.
exemple : "shipped"

fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nom localisé du statut de traitement ; null tant qu'aucun statut de traitement n'est attribué.

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

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

discountConfig: IOrderDiscountConfig | null
Configuration de remise résolue pour la commande : orderDiscounts, productDiscounts, coupon, settings, bonus et totaux. null pour les anciennes commandes sans configuration résolue.

discountConfig.bonus: IOrderDiscountBonus | null
Résultat du calcul des bonus : null lorsque les bonus ne sont pas utilisés ; omis lorsque la commande n'a pas de contexte de bonus.

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

discountConfig.orderDiscounts: unknown[]
Remises au niveau de la commande trouvées et appliquées.

discountConfig.productDiscounts: unknown[]
Remises au niveau des produits trouvées et appliquées.

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

discountConfig.additionalDiscountsMarkers: string[]
Marqueurs des remises supplémentaires demandées par le client. Omis dans les réponses d'aperçu.

discountConfig.bonusApplied: number
Montant de bonus appliqué à la commande. Omis dans les réponses d'aperçu.
exemple : 0

discountConfig.excludedGiftProductIds: string[]
ID des produits exclus de la sélection de cadeaux. Omis dans les réponses d'aperçu.

discountConfig.totalDue: number
Montant total dû après remises et bonus (omis dans les réponses d'aperçu).
exemple : 300

discountConfig.totalRaw: number
Montant total avant remises (omis dans les réponses d'aperçu).
exemple : 300

discountConfig.totalSumWithDiscount: number
Montant total après remises mais avant bonus (omis dans les réponses d'aperçu).
exemple : 300

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

split.completed: boolean
Indique si toutes les étapes du paiement fractionné sont terminées.
exemple : false

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

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

distance: number
Distance cosinus à la requête. Renvoyée sur chaque élément par l'endpoint de recherche sémantique (vectorielle).
exemple : 0.12