Pular para conteúdo

Enumerações da API

Este documento contém todas as enumerações utilizadas na API.


Status do Pedido (OrderStatus)

Enum que representa os diferentes estágios de um pedido.

Código Status Descrição
0 Pedido Iniciado O pedido foi criado na plataforma.
1 Pedido Confirmado/Pedido Impresso O pedido foi confirmado ou foi impresso
2 Em Preparação/Em separação O pedido está sendo preparado/separado.
3 Preparação Concluída/Separação Concluída Preparação ou serpação concluida.
4 Em Montagem/Faturado O pedido está sendo montado ou Pedido Faturado.
5 Aguardando Retirada Pedido pronto para retirada.
6 Em Processo de Entrega Pedido saiu para entrega.
7 Pedido Entregue O pedido foi entregue ao cliente.
8 Pedido Finalizado O pedido foi concluído.
10 Pedido Cancelado O pedido foi cancelado.

Método de Pagamento (MethodPayment)

Enum que representa os diferentes métodos de pagamento aceitos.

Código Método de Pagamento Descrição
1 Dinheiro Pagamento em dinheiro.
2 Cartão de Crédito Pagamento com cartão de crédito.
3 Cartão de Débito Pagamento com cartão de débito.
4 Pix Pagamento via Pix.
5 Boleto Pagamento com boleto bancário.
6 Transferência Bancária Pagamento via transferência bancária.
7 Vale Alimentação Pagamento com vale-alimentação.
8 Vale Refeição Pagamento com vale-refeição.
12 Criptomoeda Pagamento com criptomoeda.
99 Outro Outro meio de pagamento.

Tipos de Pedido (OrderType)

Enum que define os diferentes tipos de pedido disponíveis.

Código Tipo de Pedido Descrição
0 Pedido Local Pedido realizado e consumido no local.
1 Pedido com Entrega Pedido entregue no endereço do cliente.
10 Pedido via Ifood Pedido feito através da plataforma iFood.

Tipo de Produto (TypeProduct)

Enum que representa os diferentes tipos de produto.

Código Tipo de Produto Descrição
1 Pharmacy Produtos relacionados a farmácia e medicamentos.
2 Outers Outros tipos de produtos não categorizados como farmácia.

Tipo de Receita Médica (TypeRecipe)

Enum que representa os diferentes tipos de receitas médicas utilizadas para prescrição de medicamentos.

Código Tipo de Receita Descrição
0 SimpleWhitePrescription Receita branca simples.
1 SpecialWhitePrescription Receita branca especial.
2 SpecialControlPrescription Receita de controle especial.
3 BluePrescriptionB1B2 Receita azul (B1 e B2).
4 YellowPrescriptionA1A2 Receita amarela (A1 e A2).
5 SpecialPrescriptionForThalidomide Receita especial para talidomida.
6 GreenPrescriptionC1C5 Receita verde (C1 a C5).
7 OverTheCounterMedications Medicamentos isentos de prescrição.

Tipo de Canal (TpChanelEnum)

Enum que representa os diferentes tipos de canais utilizados para operações de delivery ou serviços.

Código Tipo de Canal Descrição
1 Ifood_Mercado Representa o canal de delivery de mercados no iFood.
2 Ifood_Restaurante Representa o canal de delivery de restaurantes no iFood.
99 NaoInformado Canal não informado ou indefinido.