getOrderByMarker

Obtenha um objeto de armazenamento de pedido por marcador 🔐 Este método requer autorização.

Orders.getOrderByMarker(marker, langCode)

const value = await Orders.getOrderByMarker('meu-pedido')

Esquema

marker:* string
O identificador de texto do objeto de armazenamento do pedido
exemplo: meu-pedido

langCode: string
Campo de idioma opcional
exemplo: pt_BR

Este método recupera um objeto de armazenamento de pedido por marcador.

Exemplo de retorno:

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

Esquema

id: number
identificador do objeto
exemplo: 1764

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

{
  "pt_BR": {
    "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: catalogo

generalTypeId number
identificador do tipo
exemplo: 4

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

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

[
  {
    "identifier": "p1"
  }
]