updateOrderByMarkerAndId

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

Orders.updateOrderByMarkerAndId(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.updateOrderByMarkerAndId('my-order', 1, body)

Schéma

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

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

data:* IOrderData
Objet pour mettre à jour une commande
exemple :

langCode: chaîne de caractères
Champ de langue optionnel
exemple : en_US

Schéma (body)

formIdentifier: chaîne de caractères
identifiant textuel de l'objet formulaire lié au stockage des commandes
exemple : bars

paymentAccountIdentifier: chaîne de caractères
identifiant textuel de l'objet de paiement lié au stockage des commandes
exemple : payment1

statusIdentifier chaîne de caractères
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 des commandes
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.00

quantity nombre
quantité du produit
exemple : 1

Cette méthode met à jour 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 de caractères
identifiant textuel du statut de la commande
exemple : inprogress

formIdentifier: chaîne de caractères
identifiant textuel du statut du formulaire
exemple : order-form

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

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

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

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

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

currency chaîne de caractères
devise utilisée pour payer la commande
exemple : USD

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