Saltar al contenido principal

createOrder

Crear 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. Crea un pedido en el almacenamiento de pedidos especificado. Devuelve una Promesa que se resuelve en un objeto IBaseOrdersEntity.

Pedidos.createOrder(

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

);

Esquema de parámetros

Esquema

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

body(requerido): 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
}
]
}

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

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

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

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

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

formData.type(requerido): string
Tipo de valor.
ejemplo: "string"

formData.value(requerido): string
Valor.
ejemplo: "Nombre"

body.products(requerido): IOrderProductData[]
Un array de productos ordenados.

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

Ejemplos

Ejemplo mínimo

const body = {
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "efectivo",
"formData": {
{
"marker": "nombre_pedido",
"type": "string",
"value": "Iván"
}
},
"products": [
{
"productId": 2,
"quantity": 2
}
]
};

const response = await Pedidos.createOrder("mi-pedido", body);

Ejemplo de respuesta

{
"id": 276,
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "cash",
"formData": [
{
"marker": "order_name",
"value": "Iván",
"type": "string"
}
],
"products": [
{
"productId": 2957,
"quantity": 2
}
],
"currency": "",
"totalSum": 300,
"createdDate": "2025-09-30T20:32:45.338Z"
}

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 al almacenamiento de pedidos.
ejemplo:

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

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