Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

CONTEÚDO


01. VISÃO GERAL
Âncora
ver_geral
ver_geral

Este endpoint é utilizado para envio enviar requisições de requisição para novos pedidos de mesa via barramento na API Order mesa via barramento., 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étodoURLAmbiente
POSThttps://api-barramento.meuelevestage.com/order/newOrderHomogação
POST

03. EXEMPLO DE UTILIZAÇÃO

Corpo da requisição de envio de novo: 

Informações
titleNota:

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)

  • Descrição: Objeto contendo informações detalhadas sobre o pedido.

    Campos do data:

    • id (string, obrigatório)

      • Descrição: Identificador único do pedido. Este ID é gerado pelo aplicativo de pedidos.
      • Exemplo: "string"
    • type (string, obrigatório)

      • Descrição: Tipo do pedido, indicando a modalidade de entrega ou consumo.
      • Valores possíveis: "DELIVERY", "TAKEOUT", "INDOOR", "TABLE", "CARD", "COUNTER"
      • Exemplo: "DELIVERY"
    • displayId (string, obrigatório)

      • Descrição: ID do pedido exibido na interface do aplicativo de pedidos para o cliente.
      • Exemplo: "string"
    • sourceAppId (string)

      • Descrição: ID do aplicativo de pedidos que originou o pedido. Ajuda a identificar o aplicativo dentro de um Hub de integração.
      • Exemplo: "string"
    • salesChannel (string)

      • Descrição: Canal de vendas pelo qual o pedido foi originado.
      • Exemplo: "string"
    • createdAt (string, obrigatório)

      • Descrição: Data e hora de criação do pedido no formato ISO timestamp.
      • Exemplo: "2024-08-09T14:52:00Z"
    • lastEvent (string)

      • Descrição: Último evento válido do pedido, seja ele confirmado ou não.
      • Valores possíveis: "CREATED", "CONFIRMED", "DISPATCHED", "READY_FOR_PICKUP", "PICKUP_AREA_ASSIGNED", "DELIVERED", "CONCLUDED", "CANCELLATION_REQUESTED", "CANCELLATION_REQUEST_DENIED", "CANCELLED", "ORDER_CANCELLATION_REQUEST", "CANCELLED_DENIED"
      • Exemplo: "CREATED"
    • orderTiming (string, obrigatório)

      • Descrição: Indica se o pedido será entregue imediatamente ou em horário agendado.
      • Valores possíveis: "INSTANT", "SCHEDULED"
      • Exemplo: "INSTANT"
    • preparationStartDateTime (string, obrigatório)

      • Descrição: Sugestão de horário de início da preparação após a criação do pedido. Pode ser usado para informar ao estabelecimento sobre um atraso na preparação.
      • Exemplo: "2024-08-09T15:00:00Z"

merchant (objeto, obrigatório)

  • Descrição: Objeto contendo informações sobre o estabelecimento.

    Campos do merchant:

    • id (string, obrigatório)

      • Descrição: Identificador único do estabelecimento. Deve ser gerado pelo sistema de software do estabelecimento.
      • Exemplo: "string"
    • name (string, obrigatório)

      • Descrição: Nome público do estabelecimento.
      • Exemplo: "string"

items (array de objetos, obrigatório)

  • Descrição: Lista dos itens do pedido.

    Campos do items:

    • id (string, obrigatório)

      • Descrição: Identificador único do item.
      • Exemplo: "string"
    • index (string)

      • Descrição: Posição do item no pedido.
      • Exemplo: "1"
    • name (string, obrigatório)

      • Descrição: Nome do produto.
      • Exemplo: "Pizza Margherita"
    • externalCode (string, obrigatório)

      • Descrição: Código externo do produto.
      • Exemplo: "123456"
    • unit (string, obrigatório)

      • Descrição: Unidade de medida do item.
      • Valores possíveis: "UN", "KG", "L", "OZ", "LB", "GAL"
      • Exemplo: "UN"
    • ean (string)

      • Descrição: Código de barras padrão do item (EAN).
      • Exemplo: "7891234567890"
    • quantity (number, obrigatório)

      • Descrição: Quantidade de itens.
      • Exemplo: 2
    • specialInstructions (string)

      • Descrição: Instruções especiais sobre os itens.
      • Exemplo: "Sem cebola"
    • unitPrice (objeto, obrigatório)

      • Descrição: Preço por unidade do item.

      Campos do unitPrice:

      • value (number, obrigatório)

        • Descrição: Valor do preço. Aceita até 4 casas decimais.
        • Exemplo: 20.00
      • currency (string, obrigatório)

        • Descrição: Código da moeda no formato ISO 4217.
        • Exemplo: "BRL"
    • originalPrice (objeto)

      • Descrição: Preço original do produto antes de qualquer desconto. Apenas para fins informativos.

      Campos do originalPrice:

      • value (number, obrigatório)

        • Descrição: Valor do preço original.
        • Exemplo: 25.00
      • currency (string, obrigatório)

        • Descrição: Código da moeda no formato ISO 4217.
        • Exemplo: "BRL"
    • optionsPrice (objeto)

      • Descrição: Soma dos preços de todas as opções escolhidas para o item.

      Campos do optionsPrice:

      • value (number, obrigatório)

        • Descrição: Valor do preço das opções.
        • Exemplo: 5.00
      • currency (string, obrigatório)

        • Descrição: Código da moeda no formato ISO 4217.
        • Exemplo: "BRL"
    • totalPrice (objeto, obrigatório)

      • Descrição: Preço total do item, calculado como a quantidade multiplicada pelo preço unitário somado ao preço das opções.

      Campos do totalPrice:

      • value (number, obrigatório)

        • Descrição: Valor do preço total.
        • Exemplo: 45.00
      • currency (string, obrigatório)

        • Descrição: Código da moeda no formato ISO 4217.
        • Exemplo: "BRL"
    • options (array de objetos)

      • Descrição: Extras opcionais escolhidos pelo consumidor, relacionados a este item.

      Campos do options:

      • index (string)

        • Descrição: Posição da opção no pedido.
        • Exemplo: "1"
      • id (string, obrigatório)

        • Descrição: Identificador único da opção.
        • Exemplo: "string"
      • name (string, obrigatório)

        • Descrição: Nome da opção.
        • Exemplo: "Queijo Extra"
      • externalCode (string, obrigatório)

        • Descrição: Código externo do produto da opção.
        • Exemplo: "789456123"
      • unit (string, obrigatório)

        • Descrição: Unidade de medida da opção.
        • Valores possíveis: "UN", "KG", "L", "OZ", "LB", "GAL"
        • Exemplo: "UN"
      • ean (string)

        • Descrição: Código de barras padrão da opção (EAN).
        • Exemplo: "7891236547890"
      • quantity (number, obrigatório)

        • Descrição: Quantidade de opções.
        • Exemplo: 1
      • unitPrice (objeto, obrigatório)

        • Descrição: Preço por unidade da opção.

        Campos do unitPrice:

        • value (number, obrigatório)

          • Descrição: Valor do preço. Aceita até 4 casas decimais.
          • Exemplo: 2.00
        • currency (string, obrigatório)

          • Descrição: Código da moeda no formato ISO 4217.
          • Exemplo: "BRL"
      • originalPrice (objeto)

        • Descrição: Preço original da opção antes de qualquer desconto. Apenas para fins informativos.

        Campos do originalPrice:

        • value (number, obrigatório)

          • Descrição: Valor do preço original.
          • Exemplo: 2.50
        • currency (string, obrigatório)

          • Descrição: Código da moeda no formato ISO 4217.
          • Exemplo: "BRL"
      • totalPrice (objeto, obrigatório)

        • Descrição: Preço total da opção, calculado como a quantidade multiplicada pelo preço unitário.
        • Exemplo: 2.00
Informações
titleInformação:

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

orderKey: é o código do pedido

Dica
titleDica

Para obter detalhes técnicos sobre como realizar uma requisição à API Order  no endpoint de payment para enviar um item com valor integral, clique aqui.

https://api-barramento.meueleve.com.br/order/newOrderProdução


...


03. DICIONÁRIO
Âncora
dicionario
dicionario


  • Estrutura newOrder:

Campo

Valor

Descrição

integrationHubServiceId *stringIdentificador único da integração

data *

arrayDados 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
EnumValorDescriçã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
EnumValueDescrição
CREATEDCREATEDCriado o pedido foi criado no sistema
CONFIRMEDCONFIRMEDConfirmado o pedido foi confirmado pelo estabelecimento
DISPATCHEDDISPATCHEDDespachado o pedido foi enviado para entrega
READY_FOR_PICKUPREADY_FOR_PICKUPPronto para Retirada o pedido está pronto para ser retirado
PICKUP_AREA_ASSIGNEDPICKUP_AREA_ASSIGNEDÁrea de Retirada Atribuída uma área específica para retirada foi designada para o pedido
DELIVEREDDELIVERED

Entregue o pedido foi entregue ao cliente

CONCLUDEDCONCLUDEDConcluído o pedido foi totalmente processado e finalizado
CANCELLATION_REQUESTEDCANCELLATION_REQUESTEDCancelamento Solicitado um pedido de cancelamento foi feito
CANCELLATION_REQUEST_DENIEDCANCELLATION_REQUEST_DENIEDSolicitação de Cancelamento Negada o pedido de cancelamento foi negado
CANCELLEDCANCELLEDCancelado: o pedido foi cancelado
ORDER_CANCELLATION_REQUESTORDER_CANCELLATION_REQUESTSolicitaçã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
EnumValueDescrição
INSTANTINSTANTInstantâneo pedido será processado e entregue imediatamente
SCHEDULEDSCHEDULEDAgendado pedido foi programado para ser entregue em um horário específico no futuro


  • Estrutura Data (dentro de merchant):
    Âncora
    table_merchant
    table_merchant
CampoValorDescrição
idstringIdentificador Ú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.
namestringNome público do comerciante


  • Estrutura Data (dentro de items):
    Âncora
    table_items
    table_items
CampoValorDescrição
idstringIdentificador único do item
indexstringPosição do item (opcional)
namestringNome do produto
externalCodestringCódigo externo do produto (opcional)
unitstringUnidade de medida do item (veja na tabela unit)
eanstringCódigo de barras EAN do item (opcional)
quantitynumberQuantidade de itens
specialInstructionsstringInstruções especiais sobre o item (opcional)
unitPricearrayPreço por unidade, considerando 4 casas decimais (veja tabela de unitPrice)
originalPricearrayPreço original do produto (opcional) (veja tabela de originalPrice)
optionsPricearrayPreço total das opções (opcional) (veja tabela de optionsPrice)
totalPricenumberPreço total do item (veja tabela de totalPrice)
optionsarrayExtras opcionais escolhidos pelo consumidor. (veja na tabela de options)
productionPointstringPonto de produção do produto


  • Estrutura Enumeração Consumption - items (dentro de unit):
    Âncora
    table_unit
    table_unit
EnumValorDescrição
UNUNUnidade de medida simples
KGKGQuilograma
LLLitro
OZOZOnça
LBLBLibra
GALGALGalão


  • Estrutura Consumption - items (dentro de unitPrice):
    Âncora
    table_unitPrice
    table_unitPrice
CampoValorDescrição
valuenumberValor do preço
currencystringCódigo da moeda ISO 4217


  • Estrutura Consumption - items (dentro de originalPrice):
    Âncora
    table_originalPrice
    table_originalPrice
CampoValorDescrição
valuenumberValor do preço
currencystringCódigo da moeda ISO 4217


  • Estrutura Consumption - items (dentro de optionsPrice):
    Âncora
    table_optionsPrice
    table_optionsPrice
CampoValorDescrição
valuenumberValor do preço
currencystringCódigo da moeda ISO 4217


  • Estrutura Consumption - items (dentro de totalPrice):
    Âncora
    table_totalPrice
    table_totalPrice
CampoValorDescrição
valuenumberValor do preço
currencystringCódigo da moeda ISO 4217


  • Estrutura Data - items (dentro de options):
    Âncora
    table_options
    table_options
CampoValorDescrição
indexstringPosição da opção (opcional)
idstringIdentificador único da opção
namestringNome da opção

externalCode

stringCódigo do produto externo
unitenumUnidade de medida da opção (veja na tabela unit)
eanstringEAN é o padrão de código de barras usado nos itens.
quantitynumberQuantidade de itens opcionais
unitPricearrayPreço por unidade, considerando 4 casas decimais (veja tabela de unitPrice).

originalPrice

arrayPreço original do produto (opcional) (veja tabela de originalPrice).
totalPricearrayPreço total da opção (veja tabela de totalPrice)
specialInstructionsstringInstruções especiais sobre a opção (opcional)
productionPointstringPonto de produção da opção (opcional)


  • Estrutura Data (dentro de otherFees):
    Âncora
    table_otherFees
    table_otherFees
CampoValorDescrição
namestringNome relacionado às taxas
typeenumTipo da taxa (veja na tabela type)
receivedByenumPedido recebido por (veja na tabela receivedBy)
receiverDocumentstringDocumento do receptor de outras taxas
pricearrayPreço da taxa(veja tabela de price).
observationstringObservação de outras taxas. Quaisquer comentários extras


  • Estrutura Enumeração Data - otherFees (dentro de type):
    Âncora
    table_OrderFeesType
    table_OrderFeesType
EnumValorDescrição
DELIVERY_FEEDELIVERY_FEETaxa de entrega
SERVICE_FEESERVICE_FEETaxa de serviço
TIPTIPGorjeta


  • Estrutura Enumeração Data - otherFees (dentro de receivedBy):
    Âncora
    table_receivedBy
    table_receivedBy
EnumValorDescrição
MARKETPLACEMARKETPLACEEntidade que recebeu o pedido é o marketplace
MERCHANTMERCHANTEntidade que recebeu o pedido é o comerciante
LOGISTIC_SERVICESLOGISTIC_SERVICESEntidade que recebeu o pedido é a logística


  • Estrutura Data - otherFees (dentro de price):
    Âncora
    table_price
    table_price
CampoValorDescrição
valuenumberValor do preço
currencystringCódigo da moeda ISO 4217


  • Estrutura Data (dentro de discounts):
    Âncora
    table_discounts
    table_discounts
CampoValorDescrição
valuenumberValor do desconto
targetenumDestino do desconto (vejna na tabela de cart)
targetIdstring

Identificador do alvo (obrigatório quando target = ITEM).

sponsorshipValues

arrayValores 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
EnumValorDescrição
CARTCARTCarrinho o desconto aplica-se ao valor total do carrinho
DELIVERY_FEEDELIVERY_FEETaxa 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
EnumValorDescrição
MARKETPLACEMARKETPLACEEntidade responsável pela entrega é o marketplace
MERCHANTMERCHANTEntidade responsável pela entrega é o comerciante


  • Estrutura Data (dentro de total):
    Âncora
    table_total
    table_total
CampoValorDescrição
itemsnumberSoma do preço total dos itens listados no atributo itens
otherFeesnumberSoma do valor total das demais taxas listadas no atributo otherFees. Se não houver, use 0
discountnumberSoma de quaisquer descontos que possam estar listados no atributo descontos. Se não houver, use 0
orderAmountnumberO valor final da encomenda (itens + outrasTaxas +Taxas adicionais +Taxa de entrega - descontos)
additionalFeesnumberSoma do valor total das taxas adicionais listadas no atributo adicionalFees. Se não houver, use 0
deliveryFeenumberSoma 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
CampoValorDescrição

prepaid

numberValor pago antecipadamente

pending

numberValor que ainda será pago

methods

arrayA 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
EnumValorDescrição

CREDIT

CREDITCrédito pagamento realizado com cartão de crédito

DEBIT

DEBITDébito pagamento realizado com cartão de débito

MEAL_VOUCHER

MEAL_VOUCHERVale-refeição pagamento realizado com um vale-refeição

FOOD_VOUCHER

FOOD_VOUCHERVale-alimentação pagamento realizado com um vale-alimentação

DIGITAL_WALLET

DIGITAL_WALLET

Carteira digital pagamento realizado via uma carteira digital.

PIX

PIXPix pagamento realizado via o sistema de pagamento instantâneo Pix

CASH

CASHDinheiro pagamento realizado em espécie

CREDIT_DEBIT

CREDIT_DEBITCrédito/Débito combinação de cartão de crédito e débito

COUPON

COUPONCupom pagamento realizado com um cupom de desconto

REDEEM

REDEEMResgatar pagamento feito através de um programa de recompensas

PREPAID_REDEEM

PREPAID_REDEEMResgatar pré-pago pagamento feito com valores pré-pagos em um programa de recompensas

OTHER

OTHEROutro pagamento realizado com outro método que não está listado


  • Estrutura Data (dentro de customer):
    Âncora
    table_customer
    table_customer
CampoValorDescrição

id

stringUm 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

stringNome do cliente

document

stringDocumento do cliente. Este documento poderá ser enviado para tratar de questões tributárias

phone

stringTelefone 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

stringE-mail do cliente. Este documento poderá ser enviado para tratar de questões tributárias

ordersCountOnMerchant

stringNúmero total de pedidos que o cliente já fez no estabelecimento


  • Estrutura Data - customer (dentro de phone):
    Âncora
    table_phone
    table_phone
CampoValorDescrição
numberstringNúmero de telefone do cliente do pedido
extensionstringSolicitar extensão de telefone do cliente


  • Estrutura Data (dentro de schedule):
    Âncora
    table_schedule
    table_schedule
CampoValorDescrição

scheduledDateTimeStart

stringData 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

stringData 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
CampoValorDescrição

deliveredBy

enumSolicitar entrega por (veja na tabela de deliveredBy)

deliveryAddress

arrayO endereço onde o pedido será entregue (veja na tabela deliveryAddress)

estimatedDeliveryDateTime

stringData e hora estimada de entrega. A mesma data mostrada ao cliente, na interface do Aplicativo de Pedidos

deliveryDateTime

stringData 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
EnumValorDescrição
MARKETPLACEMARKETPLACEEntidade responsável pela entrega é o marketplace
MERCHANTMERCHANTEntidade responsável pela entrega é o comerciante


  • Estrutura Data - delivery (dentro de deliveryAddress):
    Âncora
    table_deliveryAddress
    table_deliveryAddress
CampoValorDescição

country

stringTipo de pedido País do endereço de entrega. *Código de país ISO 3166-1 alfa-2 de duas letras.

state

stringSubdivisão de estado ou país. É recomendado (mas não obrigatório) que você use a representação ISO 3166-2

city

stringNome da cidade

district

stringBairro ou Distrito

street

stringNome da rua

number

stringNúmero da rua

complement

stringComplemento de endereço

reference

stringReferência de endereço

formattedAddress

stringTexto de endereço totalmente formatado

postalCode

stringCódigo postal

coordinates

arrayTipo de pedido Endereço de entrega Coordenadas latitude (veja na tabela coordinates)


  • Estrutura Data - delivery - deliveryAddress (dentro de coordinates):
    Âncora
    table_coordinates
    table_coordinates
CampoValorDescrição

latitude

numberLatitude em graus. Os valores estão restritos ao intervalo [[-90, 90]]

longitude

numberLongitude em graus. Os valores estão restritos ao intervalo [[-180, 180]]


  • Estrutura Data (dentro de takeout):
    Âncora
    table_takeout
    table_takeout
CampoValorDescrição
modeenumModo de pedido para viagem

takeoutDateTime

stringData 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
CampoValorDescrição
modeenumModo de pedido para viagem

indoorDateTime

stringData 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

stringO identificador do local (obrigatório se o modo for PLACE)

tab

stringA guia ou identificador do cartão de controle (obrigatório se o modo for TAB)


  • Estrutura Enumeração Data - indoor (dentro de mode):
EnumValorDescrição
DEFAULTDEFAULTPadrão isado para pedidos feitos no Aplicativo de Pedido para serem consumidos dentro do estabelecimento sem uma localização específica
PLACEPLACELugar 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
TABTABComanda 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
CampoValorDescrição

waiterCode

numberO identificador do garçom

tableNumber

numberO identificador da tabela

chairNumber

numberO identificador do presidente


  • Estrutura Consumption (dentro de card):
    Âncora
    table_card
    table_card
CampoValorDescrição

waiterCode

numberO identificador do garçom

tableNumber

numberO identificador da tabela

deliveryTableNumber

numberO identificador da mesa
Dica
titleCampos obrigatórios

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


...

...


Dica
titleSaiba 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
titleSaiba 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
titleSaiba 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.


Templatedocumentos