createOrder

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

Description

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.

Orders.createOrder( marker*, body*, langCode );

Schéma des paramètres

Schéma

marker(required): string
Identifiant textuel de l'objet de stockage des commandes
exemple : "order_storage_1"

body(required): IOrderData
Objet pour créer une commande
exemple :

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

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

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

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

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

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

value(required): string
Valeur.
exemple : "Nom"

type(required): string
Type de valeur.
exemple : "string"

products(required): 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.createOrder("my-order", body);

Exemple de réponse

{
  "id": 233,
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "marker": "order_name",
      "value": "Ivan",
      "type": "string"
    }
  ],
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ],
  "currency": "",
  "totalSum": 300,
  "createdDate": "2025-07-21T09:40:08.552Z"
}

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 commandes.
exemple :

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

products: IOrderProducts[]
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". /

---