Aller au contenu principal

getAllOrdersByMarker

Récupération de toutes les commandes à partir de l'objet de stockage des commandes créé par l'utilisateur. 🔐 Cette méthode nécessite une autorisation.

Description

Cette méthode récupère tous les objets de stockage des commandes par marqueur. La méthode ajoutera la langue par défaut au corps de la requête. Si vous souhaitez changer la langue, il vous suffit de la passer en tant que deuxième argument. Elle renvoie une promesse qui se résout en un objet IOrdersByMarkerEntity.

Orders.getAllOrdersByMarker(

marker*, langCode, offset, limit

);

Schéma des paramètres

Schéma

marker(obligatoire) : string
Identifiant textuel de l'objet de stockage des commandes
exemple : "order_storage_1"

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

offset : number
Paramètre d'offset. Par défaut : 0
exemple : 0

limit : number
Paramètre de limite. Par défaut : 30
exemple : 30

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer les permissions du module selon vos besoins dans la section correspondante.

Exemples

Exemple minimal

const response = await Orders.getAllOrdersByMarker('my-order');

Exemple avec des attributs

const response = await Orders.getAllOrdersByMarker('my-order', 'en_US', 0, 30);

Exemple de réponse

{
"items": [
{
"id": 414,
"storageId": 1,
"createdDate": "2026-01-07T04:15:58.059Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "300.00",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Espèces"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
],
"paymentUrl": null,
"isCompleted": null
},
{
"id": 413,
"storageId": 1,
"createdDate": "2026-01-07T04:11:18.556Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "300.00",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Espèces"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
],
"paymentUrl": null,
"isCompleted": null
},
{
"id": 412,
"storageId": 1,
"createdDate": "2026-01-07T02:09:46.495Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "300.00",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Espèces"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
],
"paymentUrl": null,
"isCompleted": null
},
"..."
],
"total": 231
}

Schéma de réponse

Schéma : IOrdersByMarkerEntity

items : IOrderByMarkerEntity[]
Tableau d'objets de stockage des commandes.
exemple :

[
{
"id": 55,
"storageId": 1,
"createdDate": "2025-03-22T21:12:42.371Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "300.00",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Espèces"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
],
"isCompleted": false
}
]

total : number
Nombre total d'enregistrements trouvés.
exemple : 100