getAllOrdersByMarker

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

Orders.getAllOrdersByMarker(marker, langCode, offset, limit)

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

Schéma

marker:* string
Identifiant textuel de l'objet de stockage des commandes
exemple : my-order

langCode: string
Champ de langue optionnel
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

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.

Exemple de retour :

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "statusIdentifier": "inprogress",
      "formIdentifier": "order-form",
      "formData": [
        {
          "marker": "name_1",
          "type": "string",
          "value": "Nom"
        }
      ],
      "products": [
        {
          "id": 1,
          "title": "Parquet stratifié 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": {"title": "Compte 1"
      },
      "isHistory": true
    }
  ]

}

Schéma

total: number
nombre total d'enregistrements trouvés
exemple : 100

statusIdentifier: string
identifiant textuel de l'état de la commande
exemple : inprogress

formIdentifier: string
identifiant textuel de l'état du formulaire
exemple : order-form

formData FormDataType
données soumises par le formulaire lié au stockage des commandes
exemple :

[
  {
    "marker": "name_1",
    "value": "Nom"
  }
]

products Record<string, string | any>[]
tableau de produits ajoutés à la commande

totalSum string
montant total de la commande
exemple : 12.00

currency string
devise utilisée pour payer la commande
exemple : USD

createdDate string
date à laquelle la commande a été créée
exemple : 2023-01-01 12:12

price number
prix du produit par unité (au moment de la commande)
exemple : 20.00

paymentAccountIdentifier string
identifiant textuel pour le paiement de la commande
exemple : payment-1

paymentAccountLocalizeInfos CommonLocalizeInfos
nom du compte de paiement tenant compte de la localisation
exemple :

{
  "title": "Compte 1"
}

isHistory boolean
indique que la commande a été enregistrée dans l'historique des commandes
exemple : true