Histórico da Página

...

Estrutura OrderConsumption:

Campo	Valor	Descrição
integrationHubServiceId *	string	Identificador único da integração
orderKeyType *	enum	Tipo de chave do pedido (veja na tabela orderKeyType)
orderKey *	array	Chave do pedido correspondente
success *	boolean	Indica se a operação foi bem-sucedida
consumptions	array	Detalhes dos consumos relacionados ao pedido. (veja na tabela consumptios)
error	array	o erro é necessário quando o sucesso é falso. (veja na tabela de error)

Estrutura Consumption (dentro de consumptions):
Âncora
table_consuptions
table_consuptions

Campo	Valor	Descrição
type *	enum	Tipo do consumo (veja na tabela type)
createdAt *	string (data e hora)	Data e hora da criação do pedidos
customerName *	string	Nome do cliente
items *	array	Itens do pedido (veja na tabela de items)
ortherFess	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)
delivery	array	Informações para pedidos DELIVERY. OBRIGATÓRIO se o tipo escolhido for DELIVERY. (veja tabela delivery)
takeout	array	Informações para pedidos TAKEOUT. OBRIGATÓRIO se o tipo escolhido for TAKEOUT (veja na tabela takeout)
table	array	Informações para pedidos de TABLE. OBRIGATÓRIO se o tipo escolhido for TABLE (veja na tabela table)
card	array	Informações para pedidos CARD. OBRIGATÓRIO se o tipo escolhido for CARTÃO (veja na tabela de card)

Estrutura Consumption (dentro de items):
Âncora
table_items
table_items

optionsPricearrayPreço total das opções (opcional) (veja tabela de optionsPrice)totalPricenumber

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. 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
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)

. 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	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 Consumption - 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 Consumption (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 Consumption (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 Consumption (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 Consumption (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.

Tabela de auxiliares e enumerações

Estrutura Consumption (dentro de takeout):
Âncora
table_takeout
Estrutura Enumeração orderKeyType
Âncora
table_orderKeyType
table_orderKeyTypetakeout

Enum

Campo	Valor	Descrição

TABLE

mode *

TABLE

enum

Identifica o pedido pelo número da mesaCARDCARDIdentifica o pedido pelo número do cartãoORDER_IDORDER_IDIdentifica o pedido por um ID exclusivo

Modo de pedido para viagem (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 Consumption - takeout (dentro de modeEstrutura Consumption (dentro de type):
Âncora
table_takeout_typemode
table_takeout_typemode

Campo	Valor	Descrição

value

DEFAULT*

numberValor do preçocurrencystringCódigo da moeda ISO 4217

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 Consumption (dentro de tableEstrutura Enumeração Consumption - items (dentro de unit):
Âncora
table_unittable
table_unittable

Enum

Campo	Valor	Descrição

UN

waiterCode *

UNUnidade de medida simplesKGKGQuilogramaLLLitroOZOZOnçaLBLBLibraGALGALGalão

number	O identificador do garçom
tableNumber *	number	O identificador da tabela
chairNumber *	number	O identificador do presidente

Estrutura Consumption (dentro de cardEstrutura Consumption - items (dentro de unitPrice):
Âncora
table_unitPricecard
table_unitPricecard

Campo	Valor	Descrição

value

waiterCode *

number

Valor do preçocurrencystringCódigo da moeda ISO 4217

O identificador do garçom
tableNumber *	number	O identificador da tabela
deliveryTableNumber *	number	O identificador da mesa

Estrutura ErrorEstrutura Consumption - items (dentro de originalPrice):
Âncora
table_originalPriceerror
table_originalPriceerror

Campo	Valor	Descrição

value

code *

numberValor do preçocurrencystringCódigo da moeda ISO 4217

string	Código de erro
message *	string	Mensagem de erro

Tabela de auxiliares e enumerações

Estrutura Enumeração orderKeyTypeEstrutura Consumption - items (dentro de optionsPrice):
Âncora
table_optionsPriceorderKeyType
table_optionsPriceorderKeyType

Campo

Enum	Valor	Descrição

valuenumberValor do preçocurrencystringCódigo da moeda ISO 4217

TABLE	TABLE	Identifica o pedido pelo número da mesa
CARD	CARD	Identifica o pedido pelo número do cartão
ORDER_ID	ORDER_ID	Identifica o pedido por um ID exclusivo

Estrutura Consumption (dentro de typeEstrutura Consumption - items (dentro de totalPrice):
Âncora
table_totalPricetype
table_totalPricetype

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

Estrutura Enumeração Consumption - otherFees items (dentro de typeunit):
Âncora
table_OrderFeesTypeunit
table_OrderFeesTypeunit

Enum	Valor	Descrição

DELIVERY_FEEDELIVERY_FEETaxa de entregaSERVICE_FEESERVICE_FEETaxa de serviçoTIPTIPGorjeta

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 unitPriceEstrutura Enumeração Consumption - otherFees (dentro de receivedBy):
Âncora
table_receivedByunitPrice
table_receivedByunitPrice

Enum

Campo	Valor	Descrição

MARKETPLACE

value *

MARKETPLACEEntidade que recebeu o pedido é o marketplaceMERCHANTMERCHANTEntidade que recebeu o pedido é o comercianteLOGISTIC_SERVICESLOGISTIC_SERVICESEntidade que recebeu o pedido é a logística

...

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

...

Enum

	Valor	Descrição

MARKETPLACE

value *

MARKETPLACEEntidade responsável pela entrega é o marketplaceMERCHANTMERCHANTEntidade responsável pela entrega é o comerciante

number	Valor do preço
currency *	string	Código da moeda ISO 4217

Estrutura Consumption - items Estrutura Consumption - otherFees (dentro de priceoptionsPrice):
Âncora
table_priceoptionsPrice
table_priceoptionsPrice

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

Estrutura Enumeração Consumption - discountsitems (dentro de sponsorshipValuestotalPrice):
Âncora
table_sponsorshipValuestotalPrice
table_sponsorshipValuestotalPrice

Enum

Campo	Valor	Descrição

MARKETPLACEMARKETPLACEEntidade responsável pela entrega é o marketplaceMERCHANTMERCHANTEntidade responsável pela entrega é o comerciante

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

Estrutura Enumeração Consumption - otherFees (dentro de typeEstrutura Consumption - delivery (dentro de deliveryAddress):
Âncora
table_deliveryAddressOrderFeesType
table_deliveryAddressOrderFeesType

Campo

Enum	Valor

Descição

Descriçã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)

DELIVERY_FEE	DELIVERY_FEE	Taxa de entrega
SERVICE_FEE	SERVICE_FEE	Taxa de serviço
TIP	TIP	Gorjeta

Estrutura Enumeração Consumption - otherFees (dentro de receivedByEstrutura Consumption - delivery - deliveryAddress (dentro de coordinates):
Âncora
table_coordinatesreceivedBy
table_coordinatesreceivedBy

Campo

Enum	Valor	Descrição

latitude

MARKETPLACE

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]]

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 Enumeração Consumption - delivery (dentro de deliveredByEstrutura Consumption (dentro de takeout):
Âncora
table_takeoutdeliveredBy
table_takeoutdeliveredBy

Campo

Enum	Valor	Descrição

mode

MARKETPLACE

enumModo 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

MARKETPLACE	Entidade responsável pela entrega é o marketplace
MERCHANT	MERCHANT	Entidade responsável pela entrega é o comerciante

Estrutura Consumption - otherFees (dentro de priceEstrutura Consumption (dentro de table):
Âncora
table_tableprice
table_tableprice

Campo	Valor	Descrição

waiterCode

value *

number

O identificador

Valor do

garçom

preço

tableNumber

currency *

number

string

O identificador da tabela

chairNumber

numberO identificador do presidente

Código da moeda ISO 4217

Estrutura Enumeração Consumption - discountsEstrutura Consumption (dentro de card sponsorshipValues):
Âncora
table_cardsponsorshipValues
table_cardsponsorshipValues

Campo

Enum	Valor	Descrição

waiterCode

MARKETPLACE

numberO identificador do garçom

tableNumber

numberO identificador da tabela

deliveryTableNumber

numberO identificador da mesa

MARKETPLACE	Entidade responsável pela entrega é o marketplace
MERCHANT	MERCHANT	Entidade responsável pela entrega é o comerciante

Estrutura Consumption - delivery (dentro de deliveryAddress)Estrutura Error:
Âncora
table_errordeliveryAddress
table_errordeliveryAddress

Campo	Valor

Descrição

Descição

code

country *

string

Código de erro

message

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

Mensagem de erro

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 Consumption - 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]]

Dica

title	Campos obrigatórios

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

...

04. ERROS
Âncora
erros
erros

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

...

Páginas filhas

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

04. ERROS
Âncora
erros
erros

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

04. ERROS Âncoraerroserros

04. ERROS
Âncora
erros
erros