CONTEÚDO
...
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.
...
02. ENDPOINT
...
Este endpoint é utilizado para envio de requisição para novos pedidos na API Order mesa via barrament.
...
Método | URL |
---|
Método | URL | Ambiente |
---|
POST | https://api-barramento.meuelevestage.com/order/newOrder | Homogação |
POST | https://api-barramento. |
meuelevestagemeueleve.com.br/order/newOrder | Produção |
...
03. EXEMPLO DE UTILIZAÇÃO
Corpo requerido na solicitação01. Corpo da requisição de envio de novo pedidos inteiro: Âncora |
---|
pedido_inteiro | pedido_inteiro
Bloco de código |
---|
title | JSON para pedido com inteiroCorpo requerido na solicitação |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId":"933aadb4-c33b-40b8-8285-bf1e575d8b38", "string",
"data": {
"id":"9ec389e5-7582-4768-875b-ee7c309aa34f "string",
"type": "TABLEDELIVERY",
"displayId": "29string",
"createdAtsourceAppId":"2024-06-24T17:35:00 "string",
"orderTimingsalesChannel":"2024-06-24T17:40:24 "string",
"preparationStartDateTimecreatedAt":"2024-06-24T18:00:00 "string",
"merchantlastEvent":{
"CREATED",
"orderTiming": "INSTANT",
"idpreparationStartDateTime":"c312d2ff-1a8f-40ad-8eed-9ae9a908df6e "string",
"merchant": {
"nameid":"BOTECO DO ALBINO "string",
"name": "string"
},
"items": [
{
"id": "3973594021string",
"index": "21string",
"name": "MARACUJAstring",
"externalCode": "58string",
"unit": "UN",
"ean": "string",
"quantity":1. 0,
"specialInstructions": "Testestring",
"unitPrice": {
"value":61.00 0,
"currency": "R$string"
},
"optionsPriceoriginalPrice": {
"value": 0.0,
"currency": "R$string"
},
"totalPriceoptionsPrice": {
"value":61.00 0,
"currency": "R$string"
},
"otherFeestotalPrice":[] {
}
"value": 0,
],
"totalcurrency":{ "string"
"items":61.00},
"otherFeesoptions":0, [
"discount":0.00,
{
"orderAmountindex":61.00 "string",
"additionalFeesid":0 "string",
"deliveryFeename":0 "string",
},
"paymentsexternalCode":{ "string",
"prepaidunit":0.0 "UN",
"pendingean":0.0 "string",
"methodsquantity":[ 0,
{"unitPrice": {
"value":61.00 0,
"currency": "BRLstring",
"type":"PREPAID"},
"methodoriginalPrice":"credit",
{
"methodInfovalue":"Visa" 0,
"currency": "changeForstring":0.0
},
]
"totalPrice": {
},
"delivery":null,
"extraInfovalue":"Teste" 0,
"schedule":null,
"indoorcurrency":null, "string"
"takeout":null,
"table":{},
"waiterCodespecialInstructions": "9999string",
"tableNumberproductionPoint": "29",
string"
}
],
"chairNumberproductionPoint": "1string"
},
],
"cardotherFees":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. |
Informações |
---|
|
JSON de RequestOrderNewOrder Este JSON é utilizado para enviar informações de um novo pedido, incluindo detalhes do pedido, itens, cliente, pagamentos e outras taxas associadas. Ele serve como um formato padronizado para criar pedidos através de um sistema de integração. Campos:integrationHubServiceId (string, obrigatório)- Descrição: Chave de identificação da integração. Este campo é essencial para identificar de forma única a integração em questão.
- Exemplo:
"string"
data (objeto, obrigatório)merchant (objeto, obrigatório)items (array de objetos, obrigatório) |
Informações |
---|
|
integrationHubServiceId: é um código da integração da loja com o Integration Hub orderKey: é o código do pedido |
Dica |
---|
|
Para obter informações detalhadas sobre como enviar uma requisição para a API Order no endpoint payment para a criação de um pedido completo, incluindo itens adicionais, consulte a documentação clicando aqui. |
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
...
{
"name": "string",
"type": "DELIVERY_FEE",
"receivedBy": "MARKETPLACE",
"receiverDocument": "string",
"price": {
"value": 0,
"currency": "string"
},
"observation": "string"
}
],
"discounts": [
{
"value": 0,
"target": "CART",
"targetId": "string",
"sponsorshipValues": [
{
"name": "MARKETPLACE",
"value": 0
}
]
}
],
"total": {
"items": 0,
"otherFees": 0,
"discount": 0,
"orderAmount": 0,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": {
"prepaid": 0,
"pending": 0,
"methods": [
{
"value": 0,
"currency": "string",
"type": "OFFLINE",
"method": "CREDIT",
"brand": "VISA",
"methodInfo": "string",
"changeFor": 0
}
]
},
"customer": {
"id": "string",
"name": "string",
"documentNumber": "string",
"phone": {
"number": "string",
"extension": "string"
},
"email": "string",
"ordersCountOnMerchant": "string"
},
"schedule": {
"scheduledDateTimeStart": "string",
"scheduledDateTimeEnd": "string"
},
"delivery": {
"deliveredBy": "MARKETPLACE",
"deliveryAddress": {
"country": "string",
"state": "string",
"city": "string",
"district": "string",
"street": "string",
"number": "string",
"complement": "string",
"reference": "string",
"formattedAddress": "string",
"postalCode": "string",
"coordinates": {
"latitude": 0,
"longitude": 0
}
},
"estimatedDeliveryDateTime": "string",
"deliveryDateTime": "string"
},
"takeout": {
"mode": "DEFAULT",
"takeoutDateTime": "string"
},
"indoor": {
"mode": "DEFAULT",
"indoorDateTime": "string",
"place": "string",
"tab": "string"
},
"table": {
"waiterCode": 0,
"tableNumber": 0,
"chairNumber": 0
},
"card": {
"waiterCode": 0,
"cardNumber": 0,
"deliveryTableNumber": 0
},
"sendDelivered": true,
"sendTracking": true,
"extraInfo": "string"
}
} |
...
04. DICIONÁRIO
Campo | Valor | Descrição |
---|
integrationHubServiceId * | string | Chave de identificação de 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
):
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
):
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 * | enum | Unidade de medida do item. Utilize valores fracionários para quantidades menores que a unidade de medida: Exemplo: 500 gramas = 0,5 KG (veja na tabela unit) |
ean | string | Código de barras EAN do item (opcional) |
quantity * | number | Quantidade de itens. Utilize valores fracionários para quantidades menores que a unidade de medida: Exemplo: 500 gramas = 0,5 KG |
specialInstructions | string | Instruções especiais sobre o item (opcional) |
unitPrice * | array | Preço por unidade. Este é o preço que o cliente está pagando e será considerado para cálculos totais do pedido (veja tabela de unitPrice) |
originalPrice | array | Preço original do produto. Este preço é meramente informativo e deve ser utilizado para informar o preço de um item antes de aplicar descontos no preço de tabela. Descontos aplicados durante o pedido, como cupons e vouchers, não devem ser considerados aqui. Estes devem ser informados no objeto descontos. ESTE PREÇO NÃO SERÁ CONSIDERADO PARA CÁLCULOS DE TOTAIS DO PEDIDO. (opcional) (veja tabela de originalPrice) |
optionsPrice * | array | A soma dos preços totais de todas as opções do item (opcional) (veja tabela de optionsPrice) |
totalPrice * | number | Preço total do item. (quantidade * (preço unitário + preço opções)) (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
): Â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. São aceitas 4 casas decimais |
currency | string | O código de moeda ISO 4217 de três letras |
- 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 | array | 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
):
Campo | Valor | Descrição |
---|
value * | number | Valor do preço |
currency * | string | O código de moeda ISO 4217 de três letras |
- Estrutura Data (dentro de
discounts
): Âncora |
---|
| table_discounts |
---|
| table_discounts |
---|
|
Campo | Valor | Descrição |
---|
value * | number | Valor do preço. São aceitas 4 casas decimais |
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 sponsorshipValue) |
- Estrutura Data - discounts - (dentro de
target
):
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 Data - discounts - (dentro de
sponsorshipValues
): Âncora |
---|
| table_sponsorship |
---|
| table_sponsorship |
---|
|
Enum | Valor | Descrição |
---|
name * | string | Nome do patrocínio do pedido |
value * | enum | Valor do desconto concedido pelo patrocinador. (Veja dentro da tabela value) |
- 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
):
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 Data - payment (dentro de
methodos
): Âncora |
---|
| table_methods |
---|
| table_methods |
---|
|
Campo | Valor | Descrição |
---|
value * | number | Valor do preço. São aceitas 4 casas decimais |
currency * | string | O código de moeda ISO 4217 de três letras |
type * | enum | Tipo de método de pagamento (Veja na tabela type) |
method * | enum | Método (Veja na tabela method) |
brand | enum | Bandeira (Veja na tabela brand) |
methodInfo | string | Informações sobre método de métodos de pagamento de pedidos. Informações adicionais sobre a forma de pagamento. Pode ser utilizado para indicar algumas informações úteis do meio de pagamento escolhido, como o nome da carteira ou um número de autorização. Este campo pode ser utilizado para qualquer método informado, mas é altamente recomendável preenchê-lo quando o método escolhido for OTHER. |
changeFor | number | Métodos de pagamento de pedidos alterados para. Indica o total que será pago à vista pelo cliente e que deverá ser considerado para o cálculo do troco (ex. o cliente pagará um pedido de $ 43 com uma nota de $ 50. Em seguida, 50,00 devem ser inseridos). Obrigatório apenas quando o método for CASH |
- Estrutura Enumeração Data - payment (dentro de
type
): Âncora |
---|
| table_type_payment |
---|
| table_type_payment |
---|
|
Campo | Valor | Descrição |
---|
OFFLINE | OFFLINE | Tipo de método de pagamento offiline |
ONLINE | ONLINE | Tipo de método de pagamento online |
- Estrutura Enumeração Data - payment (dentro de
methodos
):
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 Enumeração Data - payment (dentro de
brand
):
Campo | Valor | Descrição |
---|
VISA | VISA | Badeira do cartão de crédito / débito |
MASTERCARD | MASTERCARD | Badeira do cartão de crédito / débito |
DINERS | DINERS | Badeira do cartão de crédito / débito |
AMEX | AMEX | Badeira do cartão de crédito / débito |
HIPERCARD | HIPERCARD | Badeira do cartão de crédito / débito |
ELO | ELO | Badeira do cartão de crédito / débito |
AURA | AURA | Badeira do cartão de crédito / débito |
DISCOVER | DISCOVER | Badeira do cartão de crédito / débito |
VR_BENEFICIOS | VR_BENEFICIOS | Badeira do cartão de crédito / débito |
SODEXO | SODEXO | Badeira do cartão de crédito / débito |
TICKET | TICKET | Badeira do cartão de crédito / débito |
GOOD_CARD | GOOD_CARD | Badeira do cartão de crédito / débito |
BANESCARD | BANESCARD | Badeira do cartão de crédito / débito |
SOROCARD | SOROCARD | Badeira do cartão de crédito / débito |
POLICARD | POLICARD | Badeira do cartão de crédito / débito |
VALECARD | VALECARD | Badeira do cartão de crédito / débito |
AGICARD | AGICARD | Badeira do cartão de crédito / débito |
JCB | JCB | Badeira do cartão de crédito / débito |
CREDSYSTEM | CREDSYSTEM | Badeira do cartão de crédito / débito |
CABAL | CABAL | Badeira do cartão de crédito / débito |
GREEN_CARD | GREEN_CARD | Badeira do cartão de crédito / débito |
VEROCHEQUE | VEROCHEQUE | Badeira do cartão de crédito / débito |
AVISTA | AVISTA | Badeira do cartão de crédito / débito |
OTHER | "OTHER" Indica a marca do cartão selecionado no campo método. Este campo só deverá ser preenchido se o método for CREDIT, DEBIT, CREDIT_DEBIT, MEAL_VOUCHER ou FOOD_VOUCHER. Se OTHER for escolhido, é recomendado que você descreva o nome da marca no campo methodInfo |
- 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 |
documentNumber | string | Documento do cliente. Este documento poderá ser enviado para tratar de questões tributárias |
phone * | array | 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
):
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 | Esse campo especifica o modo de retirada do pedido, ou seja, como o cliente fará a retirada (Veja na tabela mode) |
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 Enumeração Data - takeout (dentro de
mode
): Âncora |
---|
| table_takeout_mode |
---|
| table_takeout_mode |
---|
|
Campo | Valor | Descrição |
---|
DEFAULT* | DEFAULT | Indica que o pedido será retirado pelo cliente sem um local específico de coleta, ou seja, de maneira padrão no estabelecimento |
PICKUP_AREA* | PICKUP_AREA | Indica que o pedido será retirado em uma área de coleta designada dentro do estabelecimento |
- Estrutura Data (dentro de
indoor
):
Campo | Valor | Descrição |
---|
mode * | enum | Informações para pedidos INDOOR. OBRIGATÓRIO se o tipo escolhido for INDOOR (Veja na tabela mode) |
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
): Âncora |
---|
| table_indoor_mode |
---|
| table_indoor_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
):
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
):
Campo | Valor | Descrição |
---|
waiterCode * | number | O identificador do garçom |
tableNumber * | number | O identificador da tabela |
deliveryTableNumber * | number | O identificador da mesa |
Dica |
---|
|
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
Nota |
---|
title | Nota - pedido item valor integral |
---|
|
Para mais detalhes sobre como enviar uma requisição para o endpoint New Order Mesa - Item com Valor Integral, consulte a documentação |
Nota |
---|
title | Nota - pedido itens fracionandos |
---|
|
Para mais detalhes sobre como enviar uma requisição para o endpoint New Order Mesa - Itens Fracionandos, consulte a documentação |
Nota |
---|
title | Nota - pedido vários items |
---|
|
Para mais detalhes sobre como enviar uma requisição para o endpoint New Order Mesa - Pedido Vários Itens, consulte a documentação |
...
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": "9b6f45cb-effb-4b0c-b782-f934b45c109e",
"data": {
"id": "80137319-c82d-499c-af0f-00118ec06f91",
"type": "TABLE",
"displayId": 55,
"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": "54",
"index": "54",
"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.0,
"otherFees": 0,
"discount": 0.0,
"orderAmount": 61.0,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": {
"prepaid": 0.0,
"pending": 0.0,
"methods": [
{
"value": 61.0,
"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": "54",
"chairNumber": "1"
},
"card": null
}
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "displayId",
"message": "body.data.displayId must be a string"
}
]
} |
02. JSON enviando faltando um ou mais campos.
Bloco de código |
---|
title | JSON Inválido |
---|
linenumbers | true |
---|
|
{
"integrationHubServiceId": "6e7d1a42-9d59-4dd8-9976-8d8edc2a106a",
"data": {
"id": "f1bddb3f-63c4-4b2f-be53-e4527275ad9d",
"type": "TABLE",
"displayId": "55",
"createdAt": "2024-06-24T17:35:00",
"orderTiming": "2024-06-24T17:40:24",
"preparationStartDateTime": "2024-06-24T18:00:00",
"items": [
{
"id": "54",
"index": "54",
"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.0,
"otherFees": 0,
"discount": 0.0,
"orderAmount": 61.0,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": {
"prepaid": 0.0,
"pending": 0.0,
"methods": [
{
"value": 61.0,
"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": "54",
"chairNumber": "1"
},
"card": null
}
} |
Bloco de código |
---|
title | JSON Resposta |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
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/paymentS |
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": "3fea8768-bbd9-454b-9e7b-40841e9a681A",
"data": {
"id": "f1bddb3f-63c4-4b2f-be53-e4527275ad9d",
"type": "TABLE",
"displayId": "55",
"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": "54",
"index": "54",
"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.0,
"otherFees": 0,
"discount": 0.0,
"orderAmount": 61.0,
"additionalFees": 0,
"deliveryFee": 0
},
"payments": {
"prepaid": 0.0,
"pending": 0.0,
"methods": [
{
"value": 61.0,
"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": "54",
"chairNumber": "1"
},
"card": null
}
} |
Bloco de código |
---|
title | JSON Response |
---|
linenumbers | true |
---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"3fea8768-bbd9-454b-9e7b-40841e9a681A\" 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. |
...
05. LINKS