getAllOrdersStorage

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

Orders.getAllOrdersStorage(langCode, offset, limit)

const value = await Orders.getAllOrdersStorage()

Esquema

langCode: número
Campo de idioma opcional
exemplo: en_US

offset: número
Parâmetro opcional para paginação, o padrão é 0
exemplo: 0

limit: número
Parâmetro opcional para paginação, 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 retorno:

[
  {
    "id": 1764,
    "localizeInfos": {
        "title": "Pedido 1"
    },
    "identifier": "catalog",
    "generalTypeId": 4,
    "formIdentifier": "catalog-form",
    "paymentAccountIdentifiers": [
      {
        "identifier": "p1"
      }
    ]
  }
]

Esquema

id: número
identificador do objeto
exemplo: 1764

localizeInfos: Record<string, any>
descrição em json do objeto de dados da página principal levando em conta o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

identifier string
identificador textual para o campo do registro
exemplo: catalog

generalTypeId número
identificador do tipo
exemplo: 4

formIdentifier string
identificador textual para o formulário usado pelo armazenamento de pedidos
exemplo: catalog-form

paymentAccountIdentifiers Array<{ identifier: string }
array de identificadores textuais de contas de pagamento usadas pelo armazenamento de pedidos
exemplo:

[
  {
    "identifier": "p1"
  }
]

---