getOrderByMarker
Obtém um objeto de armazenamento de pedido por marcador. 🔐 Este método requer autorização?.
Pedidos?.getOrderByMarker( marker?, langCode? );
Exemplo mínimo
const value = await Orders.getOrderByMarker('meu-pedido')
Esquema
marker(required): string
Marcador do objeto de pedido
exemplo: "order_storage_1"
langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"
Este método recupera um objeto de armazenamento de pedido por marcador.
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: "order_storage_1"
formIdentifier: string
Identificador textual para o formulário usado pelo armazenamento de pedidos.
exemplo: "formulario-pedidos"
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": "pagamento-1"
}
]