getAllOrdersStorage

Obteniendo todos los objetos de almacenamiento de pedidos. 🔐 Este método requiere autorización.

Descripción

Este método obtiene todos los objetos de almacenamiento de pedidos. El método añadirá el idioma predeterminado al cuerpo de la solicitud. Si deseas cambiar el idioma, simplemente pásalo como segundo argumento. Devuelve una Promesa que se resuelve en un array de objetos IOrdersEntity.

Orders.getAllOrdersStorage(

langCode, offset, limit

);

Esquema de parámetros

Esquema

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

offset: number
Parámetro opcional para la paginación. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro opcional para la paginación. Predeterminado: 30
ejemplo: 30

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

Ejemplos

Ejemplo mínimo

const response = await Orders.getAllOrdersStorage();

Ejemplo con atributos

const response = await Orders.getAllOrdersStorage('en_US', 0, 30);

Ejemplo de respuesta

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "Mi pedido"
    },
    "position": 1,
    "identifier": "mi_pedido",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "efectivo"
      },
      {
        "identifier": "stripe"
      }
    ]
  }
]

Esquema de respuesta

Esquema: IOrdersEntity[]

id: number
Identificador del objeto.
ejemplo: 1

localizeInfos: ILocalizeInfo
Nombre considerando la localización.
ejemplo:

{
  "title": "Efectivo"
}

position: number | null
Posición en el almacenamiento de pedidos.
ejemplo: 1

identifier: string
Identificador textual para el campo del registro.
ejemplo: "order_storage_1"

formIdentifier: string
Identificador textual para el formulario utilizado por el almacenamiento de pedidos.
ejemplo: "bar-orders-form"

generalTypeId: number | null
Identificador del tipo.
ejemplo: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Array de identificadores textuales de cuentas de pago utilizadas por el almacenamiento de pedidos.
ejemplo:

[
  {
    "identifier": "payment-1"
  }
]

---