getAllOrdersStorage

Obtendo todos os objetos de armazenamento de pedidos. 🔐 Este método requer autorização.

Descrição

Este método recupera todos os objetos de armazenamento de pedidos configurados para o projeto, com paginação. Ele retorna uma Promise que resolve para um array de objetos IOrdersEntity.

Pedidos.getAllOrdersStorage(

langCode, offset, limit

);

Esquema de parâmetros

Esquema

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro opcional para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro opcional para paginação. Padrão: 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

const response = await Orders.getAllOrdersStorage();

Exemplo com atributos

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

Exemplo de resposta

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "My order"
    },
    "position": 1,
    "identifier": "my_order",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "stripe"
      },
      {
        "identifier": "cash"
      },
      {
        "identifier": "paypal"
      }
    ]
  }
]

Esquema de resposta

Esquema: IOrdersEntity[]

id: number
Identificador do objeto.
exemplo: 1

localizeInfos: ILocalizeInfo
Nome considerando a localização.
exemplo:

{
  "title": "Cash"
}

position: number | null
Posição no armazenamento de pedidos.
exemplo: 1

identifier: string
Identificador textual para o campo do registro.
exemplo: "order_storage_1"

formIdentifier: string
Identificador textual para o formulário usado pelo armazenamento de pedidos.
exemplo: "bar-orders-form"

generalTypeId: number | null
Identificador do tipo.
exemplo: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Array de identificadores textuais das contas de pagamento usadas pelo armazenamento de pedidos.
exemplo:

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

paymentAccountIdentifiers.identifier: string
Identificador textual da conta de pagamento.
exemplo: "payment-1"

---