Exibir origem

CONTEÚDO

Visão Geral
Endpoint
Dicionário
Links

01. VISÃO GERAL

Este endpoint é utilizado para enviar requisições de novos pedidos de mesa via barramento na API Order, focado em consumo no local. Ele permite gerenciar pedidos associados a mesas específicas, incluindo informações de itens, descontos, extras, métodos de pagamento, e identificação de mesa e/ou cartão consumo.

02. ENDPOINT

Método	URL	Ambiente
POST	https://api-barramento.meuelevestage.com/order/newOrder	Homogação
POST	https://api-barramento.meueleve.com.br/order/newOrder	Produção

02. DICIONÁRIO

Estrutura newOrder:

Campo	Valor	Descrição
integrationHubServiceId *	string	Identificador único da integração
data *	array	Dados necessário para o pedido

Tabela de auxiliares e enumerações:

Estrutura newOrder (dentro de data):

Campo	Valor	Descrição
id *	string	O identificador exclusivo do pedido. O ID do pedido é gerado pelo Aplicativo de Pedidos
type *	enum	Tipo de pedido (veja na tabela type)
displayId *	string	ID do pedido mostrado na interface do aplicativo de pedidos do cliente
sourceAppId	string	Este campo deverá ser preenchido com o AppId do Aplicativo de Pedido que originou o pedido. Este campo serve para auxiliar as aplicações que funcionarão como Hub, intermediando as solicitações da Aplicação de Pedido com o Serviço de Software
salesChannel	string	Você pode indicar por qual canal de vendas este pedido foi originado
createdAt *	string	Data e hora de criação do pedido (data e hora UTC no formato de carimbo de data/hora ISO). **
lastEvent	string	O último evento válido pesquisado (reconhecido ou não) ou enviado via webhook.** (veja na tabela lastEvent)
orderTiming *	string	Tempo do pedido. Indica se o PEDIDO terá entrega imediata ou programada (veja na tabela orderTiming)
preparationStartDateTime *	string	Sugestão de horário de início da preparação após a criação do Pedido. Isso pode ser usado pelo Aplicativo de Pedidos para informar o estabelecimento comercial sobre o atraso no início da preparação por qualquer motivo. O padrão é o mesmo horário de criação do pedido
merchant *	string	Informações do comerciante (veja na merchant)
items	array	Encomendar itens (veja na tabela items)
otherFees	array	Outras taxas que podem ser aplicadas (veja na tabela otherFees)
discounts	array	Quaisquer descontos que possam ser aplicados (veja na tabela discounts)
total	array	Conjunto de campos com a soma dos valores descritos anteriormente no pedido (veja na tabela total)
payments	string	Toda a descrição do pagamento, como formas, pré-pagamentos, troco, etc. (veja na tabela payments)
customer	string	Informações relacionadas ao cliente. OBRIGATÓRIO se o tipo escolhido for DELIVERY (veja na tabela customer)
schedule	string	Informações para pedidos agendados. OBRIGATÓRIO se orderTiming estiver AGENDADO (veja na tabela schedule)
delivery	string	Informações para pedidos DELIVERY. OBRIGATÓRIO se o tipo escolhido for DELIVERY (veja na tabela delivery)
takeout	string	Informações para pedidos TAKEOUT. OBRIGATÓRIO se o tipo escolhido for TAKEOUT (veja na tabela takeout)
indoor	string	Informações para pedidos INDOOR. OBRIGATÓRIO se o tipo escolhido for INTERIOR (veja na tabela indoor)
table	string	Informações para pedidos de TABLE. OBRIGATÓRIO se o tipo escolhido for TABLE (veja na tabela table)
card	string	Informações para pedidos CARD. OBRIGATÓRIO se o tipo escolhido for CARTÃO (vejna na tabela card)
sendDelivered	boolean	Este campo indica se é necessário que o Serviço de Software faça uma solicitação ao terminal para indicar ao Aplicativo de Pedido que o pedido foi entregue ao cliente. true: Indica que o Aplicativo de Pedido está aguardando uma solicitação. falso: ou não informado: Não é obrigatório fazer solicitação.
sendTracking	boolean	Este campo indica se é necessário que o Serviço de Software faça uma solicitação ao terminal para informar o Aplicativo de Pedido sobre atualizações de entrega. true: Indica que o Aplicativo de Pedido está aguardando uma solicitação. falso: ou não informado: Não é obrigatório fazer solicitação.
extraInfo	string	Informações extras, se necessário

Estrutura Data (dentro de merchant):

Campo	Valor	Descrição
id	string	Identificador Único. Identifica o estabelecimento comercial nos diferentes sistemas com os quais o estabelecimento comercial irá se comunicar. Este ID deve ser gerado pelo Software Service do comerciante. Para evitar duplicatas entre diferentes comerciantes, é recomendado que o software crie o MerchantId usando: Documento do comerciante + UUID Se isso não for possível, recomenda-se usar pelo menos um UUID.
name	string	Nome público do comerciante

Estrutura Data (dentro de items):

Campo	Valor	Descrição
id	string	Identificador único do item
index	string	Posição do item (opcional)
name	string	Nome do produto
externalCode	string	Código externo do produto (opcional)
unit	string	Unidade de medida do item (veja na tabela unit)
ean	string	Código de barras EAN do item (opcional)
quantity	number	Quantidade de itens
specialInstructions	string	Instruções especiais sobre o item (opcional)
unitPrice	array	Preço por unidade, considerando 4 casas decimais (veja tabela de unitPrice)
originalPrice	array	Preço original do produto (opcional) (veja tabela de originalPrice)
optionsPrice	array	Preço total das opções (opcional) (veja tabela de optionsPrice)
totalPrice	number	Preço total do item (veja tabela de totalPrice)
options	array	Extras opcionais escolhidos pelo consumidor. (veja na tabela de options)
productionPoint	string	Ponto de produção do produto

Estrutura Enumeração Consumption - items (dentro de unit):

Enum	Valor	Descrição
UN	UN	Unidade de medida simples
KG	KG	Quilograma
L	L	Litro
OZ	OZ	Onça
LB	LB	Libra
GAL	GAL	Galão

Estrutura Consumption - items (dentro de unitPrice):

Campo	Valor	Descrição
value	number	Valor do preço
currency	string	Código da moeda ISO 4217

Estrutura Consumption - items (dentro de originalPrice):

Campo	Valor	Descrição
value	number	Valor do preço
currency	string	Código da moeda ISO 4217

Estrutura Consumption - items (dentro de optionsPrice):

Campo	Valor	Descrição
value	number	Valor do preço
currency	string	Código da moeda ISO 4217

Estrutura Consumption - items (dentro de totalPrice):

Campo	Valor	Descrição
value	number	Valor do preço
currency	string	Código da moeda ISO 4217

Estrutura Data - items (dentro de options):

Campo	Valor	Descrição
index	string	Posição da opção (opcional)
id	string	Identificador único da opção
name	string	Nome da opção
externalCode	string	Código do produto externo
unit	enum	Unidade de medida da opção (veja na tabela unit)
ean	string	EAN é o padrão de código de barras usado nos itens.
quantity	number	Quantidade de itens opcionais
unitPrice	array	Preço por unidade, considerando 4 casas decimais (veja tabela de unitPrice).
originalPrice	array	Preço original do produto (opcional) (veja tabela de originalPrice).
totalPrice	array	Preço total da opção (veja tabela de totalPrice)
specialInstructions	string	Instruções especiais sobre a opção (opcional)
productionPoint	string	Ponto de produção da opção (opcional)

Estrutura Data (dentro de otherFees):

Campo	Valor	Descrição
name	string	Nome relacionado às taxas
type	enum	Tipo da taxa (veja na tabela type)
receivedBy	enum	Pedido recebido por (veja na tabela receivedBy)
receiverDocument	string	Documento do receptor de outras taxas
price	array	Preço da taxa(veja tabela de price).
observation	string	Observação de outras taxas. Quaisquer comentários extras

Estrutura Enumeração Data - otherFees (dentro de type):

Enum	Valor	Descrição
DELIVERY_FEE	DELIVERY_FEE	Taxa de entrega
SERVICE_FEE	SERVICE_FEE	Taxa de serviço
TIP	TIP	Gorjeta

Estrutura Enumeração Data - otherFees (dentro de receivedBy):

Enum	Valor	Descrição
MARKETPLACE	MARKETPLACE	Entidade que recebeu o pedido é o marketplace
MERCHANT	MERCHANT	Entidade que recebeu o pedido é o comerciante
LOGISTIC_SERVICES	LOGISTIC_SERVICES	Entidade que recebeu o pedido é a logística

Estrutura Data - otherFees (dentro de price):

Campo	Valor	Descrição
value	number	Valor do preço
currency	string	Código da moeda ISO 4217

Estrutura Data (dentro de discounts):

Campo	Valor	Descrição
value	number	Valor do desconto
target	enum	Destino do desconto (vejna na tabela de cart)
targetId	string	Identificador do alvo (obrigatório quando target = ITEM).
sponsorshipValues	array	Valores patrocinados por qualquer uma das partes. A soma dos valores listados neste atributo deverá corresponder ao valor informado no atributo valor acima (veja na tabela sponsorshipValues)

Estrutura Data - (dentro de discounts):

Enum	Valor	Descrição
CART	CART	Carrinho o desconto aplica-se ao valor total do carrinho
DELIVERY_FEE	DELIVERY_FEE	Taxa de entrega o desconto aplica-se ao valor da taxa de entrega. Código da moeda ISO 4217
ITEM	ITEM	Item o desconto aplica-se a um item específico do pedido. Obrigatório apenas para target = ITEM

Estrutura Enumeração Data - discounts(dentro de sponsorshipValues):

Enum	Valor	Descrição
MARKETPLACE	MARKETPLACE	Entidade responsável pela entrega é o marketplace
MERCHANT	MERCHANT	Entidade responsável pela entrega é o comerciante

Estrutura Data (dentro de total):

Campo	Valor	Descrição
items	number	Soma do preço total dos itens listados no atributo itens
otherFees	number	Soma do valor total das demais taxas listadas no atributo otherFees. Se não houver, use 0
discount	number	Soma de quaisquer descontos que possam estar listados no atributo descontos. Se não houver, use 0
orderAmount	number	O valor final da encomenda (itens + outrasTaxas +Taxas adicionais +Taxa de entrega - descontos)
additionalFees	number	Soma do valor total das taxas adicionais listadas no atributo adicionalFees. Se não houver, use 0
deliveryFee	number	Soma do valor total da taxa de entrega listada no atributo deliveryFee. Se não houver, use 0

Estrutura Data (dentro de payment):

Campo	Valor	Descrição
prepaid	number	Valor pago antecipadamente
pending	number	Valor que ainda será pago
methods	array	A forma de pagamento utilizada. Seja online, na entrega, cartão de crédito, voucher, dinheiro, etc. (veja tabela methods)

Estrutura Data (dentro de type):

Enum	Valor	Descrição
DELIVERY	DELIVERY	Para pedidos que serão entregues no endereço do cliente.
TAKEOUT	TAKEOUT	Pedidos que serão retirados no estabelecimento pelo cliente.
INDOOR	INDOOR	Pedidos que serão consumidos dentro do estabelecimento.
TABLE	TABLE	Pedidos que serão consumidos à mesa.
CARD	CARD	Pedidos que terão seu consumo alocado no cartão do estabelecimento.
COUNTER	COUNTER	Pedidos que serão atendidos no balcão do estabelecimento.*

Estrutura Consumption (dentro de total):

Campo	Valor	Descrição
items	number	Soma do preço total dos itens listados no atributo itens
otherFees	number	Soma do valor total das demais taxas listadas no atributo otherFees. Se não houver, use 0
discount	number	Soma de quaisquer descontos que possam estar listados no atributo descontos. Se não houver, use 0
orderAmount	number	O valor final da encomenda (itens + outrasTaxas +Taxas adicionais +Taxa de entrega - descontos)
additionalFees	number	Soma do valor total das taxas adicionais listadas no atributo adicionalFees. Se não houver, use 0
deliveryFee	number	Soma do valor total da taxa de entrega listada no atributo deliveryFee. Se não houver, use 0

Estrutura Consumption (dentro de delevery):

Campo	Valor	Descrição
deliveredBy	enum	Solicitar entrega por (veja na tabela de deliveredBy)
deliveryAddress	array	O endereço onde o pedido será entregue (veja na tabela deliveryAddress)
estimatedDeliveryDateTime	string	Data e hora estimada de entrega. A mesma data mostrada ao cliente, na interface do Aplicativo de Pedidos
deliveryDateTime	string	Data de entrega. A data e hora em que a entrega realmente ocorreu.

Estrutura Enumeração lastEvent (dentro de data):

Enum	Valor	Descrição
CREATED	CREATED	Criado pedido foi criado no sistema
CONFIRMED	CONFIRMED	Confirmado pedido foi confirmado pelo estabelecimento
DISPATCHED	DISPATCHED	Despachado pedido foi enviado para entrega
READY_FOR_PICKUP	READY_FOR_PICKUP	Pronto para retirada pedido está pronto para ser retirado pelo cliente
PICKUP_AREA_ASSIGNED	PICKUP_AREA_ASSIGNED	Área de retirada designada uma área de retirada foi atribuída para o pedido
DELIVERED	DELIVERED	Entregue pedido foi entregue ao cliente
CONCLUDED	CONCLUDED	Concluído pedido foi finalizado com sucesso
CANCELLATION_REQUESTED	CANCELLATION_REQUESTED	Solicitação de cancelamento cliente solicitou o cancelamento do pedido
CANCELLATION_REQUEST_DENIED	CANCELLATION_REQUEST_DENIED	Solicitação de cancelamento negada o pedido de cancelamento foi negado
CANCELLED	CANCELLED	Cancelado pedido foi cancelado
ORDER_CANCELLATION_REQUEST	ORDER_CANCELLATION_REQUEST	Solicitação de cancelamento do pedido uma solicitação de cancelamento do pedido foi feita
CANCELLED_DENIED	CANCELLED_DENIED	Cancelamento negado o pedido de cancelamento foi negado após análise

Estrutura Enumeração orderTiming (dentro de data):

Enum	Value	Descrição
INSTANT	INSTANT	Instantâneo pedido será processado e entregue imediatamente
SCHEDULED	SCHEDULED	Agendado pedido foi programado para ser entregue em um horário específico no futuro

03. LINKS

API Order Mesa - Get Status
API Order Mesa - Status
API Order Mesa - Get Consumption
API Order Mesa - Consumption
API Order Mesa - Payment
API Order Mesa - Get Cancelled Items
API Order Mesa - Cancelled Items

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral acesse a documentação clicando aqui.

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens fracionando acesse a documentação clicando aqui.

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para varios itens acesse a documentação clicando aqui.