updateOrderByMarkerAndId

Modificación de pedidos en el almacenamiento de pedidos. 🔐 Este método requiere autorización?.

Pedidos?.updateOrderByMarkerAndId( marker?, body?, langCode? );

Ejemplo mínimo

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

Esquema

marker(required): string
El identificador de texto del objeto de almacenamiento de pedidos
ejemplo: "order_storage_1"

id(required): number
ID del objeto de pedido
ejemplo: 12345

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

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

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

paymentAccountIdentifier(required): string
Identificador de texto 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": "Name",
    "type": "string"
  }
]

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

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

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

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

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

Este método actualiza 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 respuesta

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

Esquema

id: number
Identificador del objeto.
ejemplo: 1

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

paymentAccountIdentifier: string
Identificador de texto 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": "Name",
    "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 de texto del objeto de estado del pedido (si no se establece, se asignará el estado predeterminado).
ejemplo: "status-1". /

---