getAllOrdersStorage

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

Pedidos?.getAllOrdersStorage( langCode?, offset?, limit? );

Exemplo mínimo

const value = await Orders.getAllOrdersStorage()

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

Este método obtém todos os objetos de armazenamento de pedidos. O método adicionará o idioma padrão ao corpo da solicitação. Se você quiser mudar o idioma, basta passá-lo como o segundo argumento.

Exemplo de resposta

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "Meu pedido"
    },
    "position": 1,
    "identifier": "meu_pedido",
    "formIdentifier": "formularioPedido",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "dinheiro"
      },
      {
        "identifier": "stripe"
      }
    ]
  }
]

Esquema

id: number
Identificador do objeto.
exemplo: 1

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

{
  "title": "Dinheiro"
}

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

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

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

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

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

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

---