getAllOrdersByMarker

Obteniendo todas las órdenes del objeto de almacenamiento de órdenes creado por el usuario 🔐 Este método requiere autorización.

Orders.getAllOrdersByMarker(marker, langCode, offset, limit)

const value = await Orders.getAllOrdersByMarker('my-order')

Esquema

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

langCode: string
Campo de idioma opcional
ejemplo: en_US

offset: number
Parámetro de desplazamiento. Por defecto 0
ejemplo: 0

limit: number
Parámetro de límite. Por defecto 30
ejemplo: 30

Este método obtiene todos los objetos de almacenamiento de órdenes 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:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "statusIdentifier": "inprogress",
      "formIdentifier": "order-form",
      "formData": [
        {
          "marker": "name_1",
          "type": "string",
          "value": "Nombre"
        }
      ],
      "products": [
        {
          "id": 1,
          "title": "Piso Laminado Maxima, 9811 Roble Mistral",
          "sku": null,
          "price": "1.00",
          "quantity": 10,
          "previewImage": [
            {
              "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
              "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
              "size": 296391,
              "previewLink": ""
            }
          ]
        }
      ],
      "totalSum": "12.00",
      "currency": "USD",
      "createdDate": "2023-01-01 12:12",
      "paymentAccountIdentifier": "payment-1",
      "paymentAccountLocalizeInfos": {"title": "Cuenta 1"
      },
      "isHistory": true
    }
  ]

}

Esquema

total: number
número total de registros encontrados
ejemplo: 100

statusIdentifier: string
identificador textual del estado de la orden
ejemplo: inprogress

formIdentifier: string
identificador textual del estado del formulario
ejemplo: order-form

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

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

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

totalSum string
monto total de la orden
ejemplo: 12.00

currency string
moneda utilizada para pagar la orden
ejemplo: USD

createdDate string
fecha en que se creó la orden
ejemplo: 2023-01-01 12:12

price number
precio del producto por unidad (en el momento de la orden)
ejemplo: 20.00

paymentAccountIdentifier string
identificador textual para el pago de la orden
ejemplo: payment-1

paymentAccountLocalizeInfos CommonLocalizeInfos
nombre de la cuenta de pago considerando la localización
ejemplo:

{
  "title": "Cuenta 1"
}

isHistory boolean
indica que la orden ha sido guardada en el historial de órdenes
ejemplo: true