createOrder

Creando un pedido en el almacenamiento de pedidos. 🔐 Este método requiere autorización.

Descripción

El método añadirá el idioma predeterminado al cuerpo de la solicitud. Si deseas cambiar el idioma, simplemente pásalo como segundo argumento.

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

Esquema de parámetros

Esquema

marker(required): string
Identificador textual del objeto de almacenamiento de pedidos
ejemplo: "order_storage_1"

body(required): IOrderData
Objeto para crear un pedido
ejemplo:

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

formIdentifier(required): string
Identificador textual del objeto de formulario vinculado al repositorio de pedidos.
ejemplo: "bar-orders-form"

paymentAccountIdentifier(required): string
Identificador textual del objeto de pago vinculado al repositorio de pedidos.
ejemplo: "payment-1"

formData(required): IOrdersFormData | IOrdersFormData[]
Datos del formulario vinculados al repositorio de pedidos.
ejemplo:

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

marker(required): string
Marcador del campo del formulario.
ejemplo: "name_1"

value(required): string
Valor.
ejemplo: "Nombre"

type(required): string
Tipo de valor.
ejemplo: "string"

products(required): IOrderProductData[]
Un array de productos pedidos.

langCode: String
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const body = {
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "efectivo",
"formData": {
{
"marker": "order_name",
"type": "string",
"value": "Iván"
}
},
"products": [
{
"productId": 2,
"quantity": 2
}
]
};
const response = await Orders.createOrder("my-order", body);

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: IBaseOrdersEntity

id: number
Identificador del objeto.
ejemplo: 1

formIdentifier: string
Identificador textual del formulario.
ejemplo: "bar-orders-form"

paymentAccountIdentifier: string
Identificador textual del pago del pedido.
ejemplo: "payment-1"

formData: IOrdersFormData[]
Datos enviados por el formulario vinculado a la tienda de pedidos.
ejemplo:

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

products: IOrderProducts[]
Array de productos añadidos al pedido.
ejemplo:

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

currency: string
Moneda utilizada para pagar el pedido.
ejemplo: "USD"

totalSum: number
Monto total del pedido.
ejemplo: NaN

createdDate: string
Fecha de creación del pedido.
ejemplo: "2023-10-01T12:00:00Z"

statusIdentifier: string
Identificador textual del objeto de estado del pedido (si no se establece, se asignará el estado predeterminado).
ejemplo: "status-1". /

---