createOrder

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

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

Esquema

marker:* string
Identificador textual del objeto de almacenamiento de pedidos
ejemplo: my-order

body:* IOrderData
Objeto para crear un pedido
ejemplo:

langCode: String
Campo de idioma opcional
ejemplo: en_US

Esquema (body)

formIdentifier: string
identificador de texto del objeto de formulario vinculado al almacenamiento de pedidos
ejemplo: bars

paymentAccountIdentifier: string
identificador de texto del objeto de pago vinculado al almacenamiento de pedidos
ejemplo: payment1

statusIdentifier: string
identificador de texto del objeto de estado del pedido (si no se especifica, se asignará el estado predeterminado)
ejemplo: inprogress

formData: FormDataType
datos enviados por el formulario vinculado al almacenamiento de pedidos
ejemplo:

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

products Record<string, string | any>[]
array de productos añadidos al pedido

productId: number
identificador del producto
ejemplo: 12

quantity: number
cantidad del producto
ejemplo: 1

Este método recupera un objeto de almacenamiento de pedidos por marcador. El método añadirá el idioma predeterminado al cuerpo de la solicitud. Si deseas cambiar el idioma, simplemente pásalo como segundo argumento.

Ejemplo de retorno:

{
  "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
}

Esquema

statusIdentifier: string
identificador de texto del estado del pedido
ejemplo: inprogress

formIdentifier: string
identificador de texto del estado del formulario
ejemplo: order-form

paymentAccountIdentifier string
identificador de texto del pago del pedido
ejemplo: payment-1

formData FormDataType
datos enviados por el formulario vinculado al almacenamiento de pedidos
ejemplo:

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

products Record<string, string | any>[]
array de productos añadidos al pedido

totalSum string
importe total del pedido
ejemplo: 12.00

currency string
moneda utilizada para pagar el pedido
ejemplo: USD

createdDate string
fecha en que se creó el pedido
ejemplo: 2023-01-01 12:12