updateOrderByMarkerAndId

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

Description

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. Elle renvoie une promesse qui se résout en un objet IBaseOrdersEntity.

Orders.updateOrderByMarkerAndId(

marker, id, body, body.formIdentifier, body.paymentAccountIdentifier, body.formData, formData.marker, formData.type, formData.value, body.products, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire): string
L'identifiant textuel de l'objet de stockage de commande
exemple : "order_storage_1"

id(obligatoire): number
ID de l'objet de commande
exemple : 12345

body(obligatoire): IOrderData
Objet pour mettre à jour une commande
exemple :

{
  "formIdentifier": "bar-orders-form",
  "paymentAccountIdentifier": "usd-payment",
  "formData": {
    "marker": "name_1",
    "value": "Nom",
    "type": "string"
  },
  "products": [
    {
      "productId": 1,
      "quantity": 2
    }
  ],
  "currency": "USD"
}

body.formIdentifier(obligatoire): string
Identifiant textuel de l'objet de formulaire lié au dépôt de commande.
exemple : "bar-orders-form"

body.paymentAccountIdentifier(obligatoire): string
Identifiant textuel de l'objet de paiement lié au dépôt de commande.
exemple : "payment-1"

body.formData(obligatoire): IOrdersFormData | IOrdersFormData[]
Données de formulaire liées au dépôt de commande.
exemple :

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

formData.marker(obligatoire): string
Marqueur du champ de formulaire.
exemple : "name_1"

formData.type(obligatoire): string
Type de valeur.
exemple : "string"

formData.value(obligatoire): string
Valeur.
exemple : "Nom"

body.products(obligatoire): IOrderProductData[]
Un tableau de produits commandés.

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

Exemples

Exemple minimal

const body = {
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "cash",
"formData": {
{
"marker": "order_name",
"type": "string",
"value": "Ivan"
}
},
"products": [
{
"productId": 2,
"quantity": 2
}
]
};
const response = await Orders.updateOrderByMarkerAndId("my-order", 1, body);

Exemple de réponse

{
  "id": 55,
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "marker": "order_name",
      "value": "Ivan",
      "type": "string"
    }
  ],
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ],
  "currency": "",
  "totalSum": 300
}

Schéma de réponse

Schéma : IBaseOrdersEntity

id: number
Identifiant de l'objet.
exemple : 1

formIdentifier: string
Identifiant textuel du formulaire.
exemple : "bar-orders-form"

paymentAccountIdentifier: string
Identifiant textuel du paiement de la commande.
exemple : "payment-1"

formData: IOrdersFormData[]
Données soumises par le formulaire lié au dépôt de commande.
exemple :

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

products: IOrderProductsData[]
Tableau de produits ajoutés à la commande.
exemple :

[
  {
    "id": 2957,
    "title": "Cosmo",
    "sku": null,
    "previewImage": null,
    "price": 150,
    "quantity": 2
  }
]

currency: string
Monnaie utilisée pour payer la commande.
exemple : "USD"

totalSum: number
Montant total de la commande.
exemple : NaN

createdDate: string
Date de création de la commande.
exemple : "2023-10-01T12:00:00Z"

statusIdentifier: string
Identifiant textuel de l'objet d'état de la commande (si non défini, l'état par défaut sera attribué).
exemple : "status-1". /

---