Histórico da Página

CONTEÚDO

...

Este endpoint é utilizado para envio de requisição para novos pedidos na API Order mesa via barrament.

Dicionário
Links

01. VISÃO GERAL
Âncora
ver_geral
ver_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
Âncora
endpoint
endpoint

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

...

URLmeuelevestage

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

...

03.

...

DICIONÁRIO
Âncora
dicionario
dicionario

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 type):
Âncora
table_type
table_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 Enumeração lastEvent (dentro de data):
Âncora
table_lastEvent
table_lastEvent

Enum	Value	Descrição
CREATED	CREATED	Criado o pedido foi criado no sistema
CONFIRMED	CONFIRMED	Confirmado o pedido foi confirmado pelo estabelecimento
DISPATCHED	DISPATCHED	Despachado o pedido foi enviado para entrega
READY_FOR_PICKUP	READY_FOR_PICKUP	Pronto para Retirada o pedido está pronto para ser retirado
PICKUP_AREA_ASSIGNED	PICKUP_AREA_ASSIGNED	Área de Retirada Atribuída uma área específica para retirada foi designada para o pedido
DELIVERED	DELIVERED	Entregue o pedido foi entregue ao cliente
CONCLUDED	CONCLUDED	Concluído o pedido foi totalmente processado e finalizado
CANCELLATION_REQUESTED	CANCELLATION_REQUESTED	Cancelamento Solicitado um pedido de cancelamento foi feito
CANCELLATION_REQUEST_DENIED	CANCELLATION_REQUEST_DENIED	Solicitação de Cancelamento Negada o pedido de cancelamento foi negado
CANCELLED	CANCELLED	Cancelado: o pedido foi cancelado
ORDER_CANCELLATION_REQUEST	ORDER_CANCELLATION_REQUEST	Solicitação de Cancelamento de Pedido uma solicitação de cancelamento do pedido foi enviada
CANCELLED_DENIED	CANCELLED_DENIED	Cancelamento Negado o cancelamento do pedido foi negado

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

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

Estrutura Data (dentro de merchant):
Âncora
table_merchant
table_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):
Âncora
table_items
table_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):
Âncora
table_unit
table_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):
Âncora
table_unitPrice
table_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):
Âncora
table_originalPrice
table_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):
Âncora
table_optionsPrice
table_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):
Âncora
table_totalPrice
table_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):
Âncora
table_options
table_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):
Âncora
table_otherFees
table_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):
Âncora
table_OrderFeesType
table_OrderFeesType

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):
Âncora
table_receivedBy
table_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):
Âncora
table_price
table_price

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

Estrutura Data (dentro de discounts):
Âncora
table_discounts
table_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 - discounts - (dentro de target):
Âncora
table_price
table_price

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):
Âncora
table_sponsorshipValues
table_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):
Âncora
table_total
table_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):
Âncora
table_payments
table_payments

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 Enumeração Data - payment (dentro de methodos):
Âncora
table_methods
table_methods

Enum	Valor	Descrição
CREDIT	CREDIT	Crédito pagamento realizado com cartão de crédito
DEBIT	DEBIT	Débito pagamento realizado com cartão de débito
MEAL_VOUCHER	MEAL_VOUCHER	Vale-refeição pagamento realizado com um vale-refeição
FOOD_VOUCHER	FOOD_VOUCHER	Vale-alimentação pagamento realizado com um vale-alimentação
DIGITAL_WALLET	DIGITAL_WALLET	Carteira digital pagamento realizado via uma carteira digital.
PIX	PIX	Pix pagamento realizado via o sistema de pagamento instantâneo Pix
CASH	CASH	Dinheiro pagamento realizado em espécie
CREDIT_DEBIT	CREDIT_DEBIT	Crédito/Débito combinação de cartão de crédito e débito
COUPON	COUPON	Cupom pagamento realizado com um cupom de desconto
REDEEM	REDEEM	Resgatar pagamento feito através de um programa de recompensas
PREPAID_REDEEM	PREPAID_REDEEM	Resgatar pré-pago pagamento feito com valores pré-pagos em um programa de recompensas
OTHER	OTHER	Outro pagamento realizado com outro método que não está listado

Estrutura Data (dentro de customer):
Âncora
table_customer
table_customer

Campo	Valor	Descrição
id	string	Um identificador exclusivo relacionado ao consumidor. Caso o Aplicativo de Pedidos não possua um Id para o cliente, este Id poderá ser gerado no momento da criação do pedido
name	string	Nome do cliente
document	string	Documento do cliente. Este documento poderá ser enviado para tratar de questões tributárias
phone	string	Telefone do cliente. Aqui você pode inserir diretamente o número de telefone do cliente (desde que o cliente tenha dado permissão para que esses dados sejam compartilhados, de acordo com as políticas locais) ou outro número de telefone (como o número de telefone da central de atendimento do aplicativo de pedidos) onde o comerciante possa se comunicar sobre problemas do pedido que afetam o cliente (como problemas de saúde) (veja tabela phone)
email	string	E-mail do cliente. Este documento poderá ser enviado para tratar de questões tributárias
ordersCountOnMerchant	string	Número total de pedidos que o cliente já fez no estabelecimento

Estrutura Data - customer (dentro de phone):
Âncora
table_phone
table_phone

Campo	Valor	Descrição
number	string	Número de telefone do cliente do pedido
extension	string	Solicitar extensão de telefone do cliente

Estrutura Data (dentro de schedule):
Âncora
table_schedule
table_schedule

Campo	Valor	Descrição
scheduledDateTimeStart	string	Data e hora em que o pedido estará pronto. Pode ser calculado pelo Aplicativo de Pedidos utilizando o tempo médio de preparo dos pratos. O padrão é o mesmo horário de criação do pedido
scheduledDateTimeEnd	string	Data e hora em que o pedido estará pronto. Pode ser calculado pelo Aplicativo de Pedidos utilizando o tempo médio de preparo dos pratos. O padrão é o mesmo horário de criação do pedido

Estrutura Data (dentro de delevery):
Âncora
table_delivery
table_delivery

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 Data - delivery (dentro de deliveredBy):
Âncora
table_deliveredBy
table_deliveredBy

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

Estrutura Data - delivery (dentro de deliveryAddress):
Âncora
table_deliveryAddress
table_deliveryAddress

Campo	Valor	Descição
country	string	Tipo de pedido País do endereço de entrega. *Código de país ISO 3166-1 alfa-2 de duas letras.
state	string	Subdivisão de estado ou país. É recomendado (mas não obrigatório) que você use a representação ISO 3166-2
city	string	Nome da cidade
district	string	Bairro ou Distrito
street	string	Nome da rua
number	string	Número da rua
complement	string	Complemento de endereço
reference	string	Referência de endereço
formattedAddress	string	Texto de endereço totalmente formatado
postalCode	string	Código postal
coordinates	array	Tipo de pedido Endereço de entrega Coordenadas latitude (veja na tabela coordinates)

Estrutura Data - delivery - deliveryAddress (dentro de coordinates):
Âncora
table_coordinates
table_coordinates

Campo	Valor	Descrição
latitude	number	Latitude em graus. Os valores estão restritos ao intervalo [[-90, 90]]
longitude	number	Longitude em graus. Os valores estão restritos ao intervalo [[-180, 180]]

Estrutura Data (dentro de takeout):
Âncora
table_takeout
table_takeout

Campo	Valor	Descrição
mode	enum	Modo de pedido para viagem
takeoutDateTime	string	Data e hora em que o pedido estará pronto. Pode ser calculado pelo Aplicativo de Pedidos utilizando o tempo médio de preparo dos pratos. O padrão é o mesmo horário de criação do pedido

Estrutura Data (dentro de indoor):
Âncora
table_indoor
table_indoor

Campo	Valor	Descrição
mode	enum	Modo de pedido para viagem
indoorDateTime	string	Data e hora em que o pedido estará pronto. Pode ser calculado pelo Aplicativo de Pedidos utilizando o tempo médio de preparo dos pratos. O padrão é o mesmo horário de criação do pedido
place	string	O identificador do local (obrigatório se o modo for PLACE)
tab	string	A guia ou identificador do cartão de controle (obrigatório se o modo for TAB)

Estrutura Enumeração Data - indoor (dentro de mode):

Enum	Valor	Descrição
DEFAULT	DEFAULT	Padrão isado para pedidos feitos no Aplicativo de Pedido para serem consumidos dentro do estabelecimento sem uma localização específica
PLACE	PLACE	Lugar usado para pedidos feitos no Aplicativo de Pedido para serem consumidos dentro do estabelecimento em uma localização específica já informada, como uma mesa ou balcão
TAB	TAB	Comanda usado para estabelecimentos que controlam pedidos por meio de comandas ou cartões de controle (pode ser usado junto com o campo de localização)

Estrutura Consumption (dentro de table):
Âncora
table_table
table_table

Campo	Valor	Descrição
waiterCode	number	O identificador do garçom
tableNumber	number	O identificador da tabela
chairNumber	number	O identificador do presidente

Estrutura Consumption (dentro de card):
Âncora
table_card
table_card

Campo	Valor	Descrição
waiterCode	number	O identificador do garçom
tableNumber	number	O identificador da tabela
deliveryTableNumber	number	O identificador da mesa

Dica

title	Campos obrigatórios

Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório

...

04. LINKS
Âncora
links
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

Dica

title	Saiba mais!

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.

Dica

title	Saiba mais!

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.

Dica

title	Saiba mais!

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.

...

Bloco de código

title	JSON para pedido com inteiro
linenumbers	true

{
   "integrationHubServiceId":"933aadb4-c33b-40b8-8285-bf1e575d8b38",
   "data":{
      "id":"9ec389e5-7582-4768-875b-ee7c309aa34f",
      "type":"TABLE",
      "displayId":"29",
      "createdAt":"2024-06-24T17:35:00",
      "orderTiming":"2024-06-24T17:40:24",
      "preparationStartDateTime":"2024-06-24T18:00:00",
      "merchant":{
         "id":"c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
         "name":"BOTECO DO ALBINO"
      },
      "items":[
         {
            "id":"3973594021",
            "index":"21",
            "name":"MARACUJA",
            "externalCode":"58",
            "unit":"UN",
            "quantity":1.0,
            "specialInstructions":"Teste",
            "unitPrice":{
               "value":61.00,
               "currency":"R$"
            },
            "optionsPrice":{
               "value":0.0,
               "currency":"R$"
            },
            "totalPrice":{
               "value":61.00,
               "currency":"R$"
            },
            "otherFees":[]
         }
      ],
      "total":{
         "items":61.00,
         "otherFees":0,
         "discount":0.00,
         "orderAmount":61.00,
         "additionalFees":0,
         "deliveryFee":0
      },
      "payments":{
         "prepaid":0.0,
         "pending":0.0,
         "methods":[
            {
               "value":61.00,
               "currency":"BRL",
               "type":"PREPAID",
               "method":"credit",
               "methodInfo":"Visa",
               "changeFor":0.0
            }
         ]
      },
      "delivery":null,
      "extraInfo":"Teste",
      "schedule":null,
      "indoor":null,
      "takeout":null,
      "table":{
         "waiterCode":"9999",
         "tableNumber":"29",
         "chairNumber":"1"
      },
      "card":null
   }
}

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

Bloco de código

title	JSON para pedido com item fracionado
linenumbers	true

{
   "integrationHubServiceId":"a13ea12d-1ffc-4f4c-a3e8-a384fe0e9e05",
   "data":{
      "id":"f853a079-d0cb-4612-847f-430460485c02",
      "type":"TABLE",
      "displayId":"29",
      "createdAt":"2024-06-24T17:35:00",
      "orderTiming":"2024-06-24T17:40:24",
      "preparationStartDateTime":"2024-06-24T18:00:00",
      "merchant":{
         "id":"3d0cbd44-a6c4-469c-8ab3-c83700672ee1",
         "name":"BOTECO DO ALBINO"
      },
      "items":[
         {
            "id":"3973594022",
            "index":"22",
            "name":"MARACUJA",
            "externalCode":"58",
            "unit":"UN",
            "quantity":0.5,
            "specialInstructions":"Teste",
            "unitPrice":{
               "value":61.00,
               "currency":"R$"
            },
            "optionsPrice":{
               "value":0.0,
               "currency":"R$"
            },
            "totalPrice":{
               "value":30.50,
               "currency":"R$"
            },
            "otherFees":[]
         }
      ],
      "total":{
         "items":30.50,
         "otherFees":0,
         "discount":0.00,
         "orderAmount":20.50,
         "additionalFees":0,
         "deliveryFee":0
      },
      "payments":{
         "prepaid":0.0,
         "pending":0.0,
         "methods":[
            {
               "value":30.50,
               "currency":"BRL",
               "type":"PREPAID",
               "method":"credit",
               "methodInfo":"Visa",
               "changeFor":0.0
            }
         ]
      },
      "delivery":null,
      "extraInfo":"Teste",
      "schedule":null,
      "indoor":null,
      "takeout":null,
      "table":{
         "waiterCode":"9999",
         "tableNumber":"29",
         "chairNumber":"1"
      },
      "card":null
   }
}

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

Bloco de código

title	JSON pedidos com desconto
linenumbers	true

{
  "integrationHubServiceId":"4c9952fd-90d6-46f1-afd2-381c21e73cfc",
  "data":{
     "id":"4c9952fd-90d6-46f1-afd2-381c21e73cfc",
     "type":"TABLE",
     "displayId":"9",
     "createdAt":"2024-06-24T17:35:00",
     "orderTiming":"2024-06-24T17:40:24",
     "preparationStartDateTime":"2024-06-24T18:00:00",
     "merchant":{
        "id":"c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
        "name":"BOTECO DO ALBINO"
     },
     "items":[
        {
           "id":"9",
           "index":"9",
           "name":"MARACUJA",
           "externalCode":"58",
           "unit":"UN",
           "quantity":1.0,
           "specialInstructions":"Teste",
           "unitPrice":{
              "value":61.00,
              "currency":"R$"
           },
           "optionsPrice":{
              "value":0.0,
              "currency":"R$"
           },
           "totalPrice":{
              "value":61.00,
              "currency":"R$"
           }
        }
     ],
     "otherFees":[],
     "discounts":[
        {
           "value":10.0,
           "target":"ITEM",
           "targetId":"9",
           "sponsorshipValues":[
              {
                 "name":"MARKETPLACE",
                 "value":0.0
              }
           ]
        }
     ],
     "total":{
        "items":61.00,
        "otherFees":0,
        "discount":10.0,
        "orderAmount":51.00,
        "additionalFees":0,
        "deliveryFee":0
     },
     "payments":{
        "prepaid":0.0,
        "pending":0.0,
        "methods":[
           {
              "value":51.00,
              "currency":"BRL",
              "type":"PREPAID",
              "method":"credit",
              "methodInfo":"Visa",
              "changeFor":0.0
           }
        ]
     },
     "delivery":null,
     "extraInfo":"Teste",
     "schedule":null,
     "indoor":null,
     "takeout":null,
     "table":{
        "waiterCode":"9999",
        "tableNumber":"9",
        "chairNumber":"1"
     },
     "card":null
  }
}

...

Bloco de código

title	JSON pedidos com item fracionando
linenumbers	true

{
	"integrationHubServiceId": "72ec722e-b643-4076-b1cd-ef388901ba66",
	"data": {
		"id": "57e20fc5-bea5-4372-9bfc-126e1961d99b",
		"type": "TABLE",
		"displayId": "9",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "10",
				"index": "10",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 30.50,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"discounts": [
			{
				"value": 10.0,
				"target": "ITEM",
				"targetId": "10",
				"sponsorshipValues": [
					{
						"name": "MARKETPLACE",
						"value": 0.0
					}
				]
			}
		],
		"total": {
			"items": 30.50,
			"otherFees": 0,
			"discount": 10.0,
			"orderAmount": 20.50,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 20.50,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "9999",
			"tableNumber": "10",
			"chairNumber": "1"
		},
		"card": null
	}
}

Bloco de código

title	Nota: HTTP Status Code = 200 OK
linenumbers	true

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

Informações

title	Nota:

Neste exemplo, os dados retornados incluem:

success: Indica se a operação foi bem-sucedida.
error: Contém informações sobre erros, se houver.
integrationHubServiceId: O identificador do serviço de integração.
orderKeyType: O tipo da chave do pedido (neste caso, "TABLE").
orderKey: A chave do pedido, que pode ser uma lista de identificadores.
lastestUpdatedStatus: A data e hora da última atualização do status do pedido.
items: Uma lista de itens relacionados ao pedido, onde cada item inclui:
- id: O identificador do item.
- status: O status atual do item, incluindo um código e uma descrição.
- deliveryAgent: Informações sobre o agente de entrega, se aplicável.
- deliveryDateTime: Data e hora de entrega, se aplicável.
- cancellationReason: Motivo do cancelamento, se aplicável.
- tableCardNumber: O número da mesa associada ao pedido.

Informações

title	Informação:

integrationHubServiceId: é um código da integração da loja com o Integration Hub

orderKey: é o código do pedido

04. ERROS

A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:

...

O código de status HTTP 400, conhecido como "Bad Request" (Requisição Inválida), indica que o servidor não pôde processar a requisição do cliente devido a uma sintaxe inválida, estrutura malformada ou dados inválidos presentes na requisição.

01. Formando inválido do JSON esperado.

Bloco de código

title	JSON Inválido
linenumbers	true

{
    "integrationHubServiceId": "393d9572-2ec9-4cda-9ad3-5b69e02c988d",
	  "orderKeyType": "string",
	   "orderKey": ["string"]
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}

02. JSON enviando faltando um ou mais campos.

Bloco de código

title	JSON Inválido
linenumbers	true

{
    "integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType is required"
		},
		{
			"key": "orderKey",
			"message": "body.orderKey is required"
		}
	]
}

03. GUID incorreto

Bloco de código

title	JSON com o GUID inválido
linenumbers	true

{
    "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

Bloco de código

title	JSON Inválido GUID incorreto
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

04. Enviando uma requisição sem informar o código da orderKey corretamente

Bloco de código

title	JSON com sem informar o código da orderKey
linenumbers	true

{
    "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
	  "orderKeyType": "TABLE",
	  "orderKey": [""]
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": 0,
			"message": "body.orderKey[0] is not allowed to be empty"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 400 Bad Request

A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente.

...

O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

Nota

title	Nota: HTTP Status Code = 401 Unauthorized

A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente.

...

O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL incorreta

Bloco de código

title	URL enviada incorreda

https://api-barramento.meuelevestage.com/order/getStatuS

Bloco de código

title	JSON Response para URL incorreta
linenumbers	true

{
	"message": "Missing Authentication Token"
}

Nota

title	Nota: HTTP Status Code = 403 - Forbidden

O cliente não enviou uma requisição para a URL incorreta.

...

O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId está incorreto ou inválido.

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true

{
    "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	  "orderKeyType": "TABLE",
	  "orderKey": ["5"]
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 404 - Not Found

IntegrationHubId incorreto ou inválido

...

O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição.

Bloco de código

title	JSON
linenumbers	true

{
    "integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

Bloco de código

title	HTTP Status Code 412 = Precpndition Failed
linenumbers	true

{
	"message": "NOT_FOUND",
	"code": 412
}

Nota

title	Nota: HTTP Status Code = 412 Precondition Failed

Alguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos.

...

O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.

Bloco de código

title	JSON da requisição
linenumbers	true

{
    "integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
	  "orderKeyType": "TABLE",
		"orderKey": ["5"]
}

Bloco de código

title	Resposta da última execução
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
	"orderKeyType": "TABLE",
	"orderKey": [
		"5"
	],
	"lastestUpdatedStatus": "2024-07-02 18:54:28",
	"items": [
		{
			"id": "de9fd388-c223-4325-a64d-08889250f839",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "5"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 429 - Too Many Requests

Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões.

...

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 14

Nova versão 41

Chave

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

02. ENDPOINT
Âncora
endpoint
endpoint

03.

DICIONÁRIO
Âncora
dicionario
dicionario

04. LINKS
Âncora
links
links

04. ERROS

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 14

Nova versão 41

Chave

01. VISÃO GERAL Âncoraver_geralver_geral

02. ENDPOINT Âncoraendpointendpoint

03.

DICIONÁRIO Âncoradicionariodicionario

04. LINKS Âncoralinkslinks

04. ERROS

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

02. ENDPOINT
Âncora
endpoint
endpoint

DICIONÁRIO
Âncora
dicionario
dicionario

04. LINKS
Âncora
links
links