createOrder

Créer une commande dans le stockage des commandes 🔐 Cette méthode nécessite une autorisation.

Orders.createOrder(marker, body, langCode)

 const body = {
    "formIdentifier": "orderForm",
    "paymentAccountIdentifier": "cash",
    "formData": {
        "marker": "order_name",
        "value": "Ivan",
        "type": "string"
    },
    "products": [
        {
            "productId": 2,
            "quantity": 2
        }
    ]
}

const value = await Orders.createOrder('my-order', body)

Schéma

marker:* chaîne
Identifiant textuel de l'objet de stockage de commande
exemple : my-order

body:* IOrderData
Objet pour créer une commande
exemple :

langCode: Chaîne
Champ de langue optionnel
exemple : en_US

Schéma (body)

formIdentifier: chaîne
identifiant textuel de l'objet de formulaire lié au stockage de commande
exemple : bars

paymentAccountIdentifier: chaîne
identifiant textuel de l'objet de paiement lié au stockage de commande
exemple : payment1

statusIdentifier: chaîne
identifiant textuel de l'objet de statut de commande (si non spécifié, le statut par défaut sera attribué)
exemple : inprogress

formData: FormDataType
données soumises par le formulaire lié au stockage de commande
exemple :

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

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

productId: nombre
identifiant du produit
exemple : 12

quantity: nombre
quantité du produit
exemple : 1

Cette méthode récupère un objet de stockage de commande 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.

Exemple de retour :

{
  "formIdentifier": "bars",
  "paymentAccountIdentifier": "payment1",
  "statusIdentifier": "inprogress",
  "formData": [
      {
        "marker": "marker_1",
        "type": "string",
        "value": "Name"
      }
  ],
  "products": [
    {
      "productId": 1,
      "quantity": 2
    },
    {
      "productId": 2,
      "quantity": 3
    }
  ],
  "createdDate": "2024-06-21T09:42:54.848Z",
  "currency": "USD",
  "totalSum": 345
}

Schéma

statusIdentifier: chaîne
identifiant textuel du statut de la commande
exemple : inprogress

formIdentifier: chaîne
identifiant textuel du statut du formulaire
exemple : order-form

paymentAccountIdentifier chaîne
identifiant textuel du paiement de la commande
exemple : payment-1

formData FormDataType
données soumises par le formulaire lié au stockage de commande
exemple :

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

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

totalSum chaîne
montant total de la commande
exemple : 12.00

currency chaîne
devise utilisée pour payer la commande
exemple : USD

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