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 l'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 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

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": 276,
      "storageId": 1,
      "createdDate": "2025-09-30T20:32:45.338Z",
      "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
    },
    {
      "id": 275,
      "storageId": 1,
      "createdDate": "2025-09-30T20:31:44.881Z",
      "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
    },
    {
      "id": 274,
      "storageId": 1,
      "createdDate": "2025-09-30T17:36:19.027Z",
      "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": 83
}

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