Histórico da Página
...
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
| endpoint | |
| endpoint |
...
- 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 * | 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):Â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. 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):Âncora table_price table_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):Â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 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):Â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 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):Âncora table_method table_method
| 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):Âncora table_brand table_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) |
| 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 | 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):Âncora table_indoor table_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):Â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 | ||
|---|---|---|
| ||
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
...
Import HTML Content
Visão Geral
Conteúdo das Ferramentas