Aller au contenu principal

getOrderByMarkerAndId

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

Orders.getOrderByMarkerAndId(marker, id, langCode)

const value = await Orders.getOrderByMarkerAndId('my-order', 1764)
Schéma

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

id:* nombre
ID de l'objet de commande
exemple : 1764

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 et identifiant.

Exemple de retour :

{
"id": 1764,
"statusIdentifier": "inprogress",
"formIdentifier": "order-form",
"formData": [
{
"marker": "name_1",
"type": "string",
"value": "Nom"
}
],
"products": [
{
"id": 1,
"title": "Laminé Floorwood Maxima, 9811 Chêne Mistral",
"sku": null,
"price": "1.00",
"quantity": 10,
"previewImage": [
{
"filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
"downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
"size": 296391,
"previewLink": ""
}
]
}
],
"totalSum": "12.00",
"currency": "USD",
"createdDate": "2023-01-01 12:12",
"paymentAccountIdentifier": "payment-1",
"paymentAccountLocalizeInfos": {
"en_US": {
"title": "Compte 1"
}
},
"isHistory": true
}
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": "Catalogue",
"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 : catalogue

generalTypeId nombre
identifiant de type
exemple : 4

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

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

[
{
"identifier": "p1"
}
]