Histórico da Página

CONTEÚDO - NÃO MEXE API

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

Esta documentação tem como finalidade demonstrar o formato JSON para envio de requisições de pedidos com vários itens, como um com valor integral, adicionais e desconto na API Order Mesa, utilizando o endpoint newOrder.

...

02. ENDPOINT
Âncora
endpoint
endpoint

Método	URL
POST	https://api-barramento.meuelevestage.com/order/newOrder

...

03. EXEMPLO DE UTILIZAÇÃO
Âncora
varios_itens
varios_itens

01. Corpo da requisição para envio de vários itens no mesmo pedido:

Bloco de código

title	JSON da requisição do vários itens no pedido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812a",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLE",
		"displayId": "8",
		"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": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 1.00,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 1.0,
							"currency": "R$"
						},
						"productionPoint": "Adicional Composicao A"
					}
				]
			},
			{
				"id": "4",
				"index": "4",
				"name": "AERADO",
				"externalCode": "2",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 37.99,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"options": [
					{
						"index": "5",
						"id": "5",
						"name": "AVELA",
						"externalCode": "4",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 37.99,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"productionPoint": "Adicional Avela"
					}
				]
			}
		],
		"otherFees": [],
		"discounts": [
			{
				"value": 1,
				"target": "ITEM",
				"targetId": "02",
				"sponsorshipValues": [
					{
						"name": "MARKETPLACE",
						"value": 10.00
					}
				]
			}
		],
		"total": {
			"items": 102.89,
			"otherFees": 38.99,
			"discount": 10.00,
			"orderAmount": 131.88,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {null,
			"prepaiddelivery": 0.0null,
			"pendingextraInfo": 0.0"Teste",
			"methodsschedule": [null,
				{"indoor": null,
					"valuetakeout": 131.88null,
					"currencytable": "BRL",
		{
			"typewaiterCode": "PREPAID8",
					"methodtableNumber": "credit8",
					"methodInfochairNumber": "Visa1",
		},
			"changeForcard": 0.0null
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "131.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}

Nota

title	Nota: HTTP Status Code = 200 OK

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

...

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:

...

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812a",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLE",
		"displayId": 8,
		"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": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 1.00,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 1.0,
							"currency": "R$"
						},
						"productionPoint": "Adicional Composicao A"
					}
				]
			},{
			{
				"idvalue": "4"1.0,
							"indexcurrency": "4R$",
				"name": "AERADO"		},
						"externalCodeproductionPoint": "2Adicional Composicao A",
				"unit": "UN",
		}
				]
			"quantity": 1,},
			{
				"specialInstructionsid": "Teste4",
				"unitPriceindex": {
					"value": 32.99"4",
					"currencyname": "R$AERADO",
				}"externalCode": "2",
				"optionsPriceunit": {"UN",
					"valuequantity": 37.991,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsoptionsPrice": [
					{
						"indexvalue": "5",
						"id": "5",
						"name": "AVELA"37.99,
						"externalCodecurrency": "4R$",
				},
				"unittotalPrice": "UN",{
						"quantityvalue": 132.99,
						"unitPricecurrency": {"R$"
				},
				"valueoptions": 37.99,[
					{
						"currencyindex": "R$5",
						}"id": "5",
						"originalPricename": {"AVELA",
							"valueexternalCode": 37.99"4",
							"currencyunit": "RSUN",
						}"quantity": 1,
						"totalPriceunitPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"productionPointoriginalPrice": "Adicional Avela"{
					}
				]"value": 37.99,
			}
		],
		"otherFeescurrency": [],
		"discounts": ["RS"
			{
				"value": 1},
						"targettotalPrice": "ITEM",{
				"targetId": "02",
				"sponsorshipValuesvalue": [
					{
37.99,
							"namecurrency": "MARKETPLACE"R$"
						},
						"valueproductionPoint": 10.00"Adicional Avela"
					}
				]
			}
		],
		"totalotherFees": {[],
			"itemsdiscounts": 102.89,[
			{
				"otherFeesvalue": 38.991,
				"discounttarget": 10.00"ITEM",
				"orderAmounttargetId": 131.88"02",
				"additionalFeessponsorshipValues": 0,[
					"deliveryFee": 0{
		},
				"paymentsname": {"MARKETPLACE",
						"prepaidvalue": 010.0,00
			"pending": 0.0,		}
			"methods": [	]
			}
	{	],
		"total": {
			"valueitems": 131102.8889,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"10.00,
					"methodorderAmount": "credit"131.88,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "131.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}

...

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812a",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLE",
		"displayId": "8",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"items": [
			{
				"id": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currencyunit": "R$UN",
						}"quantity": 1,
						"originalPriceunitPrice": {
							"value": 1.00,
							"currency": "RSR$"
						},
						"totalPriceoriginalPrice": {
							"value": 1.000,
							"currency": "R$RS"
						},
						"productionPointtotalPrice": "Adicional Composicao A"
		{
			}
				]
			}"value": 1.0,
			{
				"idcurrency": "4R$",
				"index": "4",
				"name": "AERADO"},
				"externalCode": "2",
				"unitproductionPoint": "UN",Adicional Composicao A"
					}
				"quantity": 1,]
			},
			{
				"specialInstructionsid": "Teste4",
				"unitPriceindex": {"4",
					"valuename": 32.99"AERADO",
					"currencyexternalCode": "R$"
				}2",
				"optionsPriceunit": {"UN",
					"valuequantity": 37.991,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsoptionsPrice": [
					{
						"indexvalue": "5"37.99,
						"idcurrency": "5R$",
						"name": "AVELA"},
						"externalCodetotalPrice": "4",{
						"unitvalue": "UN"32.99,
						"quantity": 1,
						"unitPrice": {
							"value": 37.99,currency": "R$"
				},
				"currencyoptions": "R$"[
						},{
						"originalPriceindex": {"5",
							"valueid": 37.99"5",
							"currencyname": "RSAVELA",
						}"externalCode": "4",
						"totalPriceunit": {"UN",
							"valuequantity": 37.991,
							"currencyunitPrice": "R$"{
							}"value": 37.99,
							"productionPointcurrency": "Adicional Avela"
					}"R$"
				]
			},
		],
		"otherFees": [],
		"discountsoriginalPrice": [{
			{
				"value": 137.99,
							"targetcurrency": "ITEMRS",
				"targetId": "02"		},
						"sponsorshipValuestotalPrice": [{
							{
"value": 37.99,
							"namecurrency": "MARKETPLACE"R$"
						},
						"valueproductionPoint": 10.00"Adicional Avela"
					}
				]
			}
		],
		"otherFees": [],
		"totaldiscounts": [
			{
				"itemsvalue": 102.891,
				"otherFeestarget": 38.99"ITEM",
				"discounttargetId": 10.00"02",
				"orderAmountsponsorshipValues": 131.88,
[
					{
						"additionalFeesname": 0"MARKETPLACE",
						"deliveryFeevalue": 010.00
					},
			"payments": {	]
			"prepaid": 0.0,}
			"pending": 0.0],
			"methodstotal": [
				{
					"valueitems": 131102.8889,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"10.00,
					"methodorderAmount": "credit"131.88,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				}
			]},
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "131.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}

...

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/newOrderS

...

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true

{
	"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLE",
		"displayId": "8",
		"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": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90FRANCESA",
					"currencyexternalCode": "R$"
				}1",
				"optionsPriceunit": {"UN",
					"valuequantity": 1.00,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsoptionsPrice": [
					{
						"indexvalue": "3",
						"id": "3",
						"name": "COMPOSICAO A",
	1.00,
					"externalCodecurrency": "201R$",
				},
				"unittotalPrice": "UN",{
						"quantityvalue": 169.90,
						"unitPricecurrency": {"R$"
				},
				"valueoptions": 1.00,
[
					{
						"currencyindex": "R$3",
						}"id": "3",
						"originalPricename": { "COMPOSICAO A",
							"valueexternalCode": 1.00"201",
							"currencyunit": "RSUN",
						}"quantity": 1,
						"totalPriceunitPrice": {
							"value": 1.000,
							"currency": "R$"
						},
						"productionPointoriginalPrice": "Adicional Composicao A"{
					}
				]
			},
			{
				"id"value": "4"1.00,
				"index": "4",
				"namecurrency": "AERADORS",
					"externalCode": "2"	},
				"unit": "UN",
				"quantitytotalPrice": 1,{
							"specialInstructionsvalue": "Teste"1.0,
							"unitPricecurrency": {"R$"
						"value": 32.99},
						"currencyproductionPoint": "R$Adicional Composicao A"
					}
				]
			},
			{
				"optionsPriceid": {"4",
					"valueindex": 37.99"4",
					"currencyname": "R$AERADO",
				}"externalCode": "2",
				"totalPriceunit": {"UN",
					"valuequantity": 32.991,
					"currencyspecialInstructions": "R$"
				}Teste",
				"optionsunitPrice": [
					{
						"indexvalue": "5"32.99,
						"idcurrency": "5R$",
				},
				"nameoptionsPrice": "AVELA",{
						"externalCodevalue": "4"37.99,
						"unitcurrency": "UNR$",
						"quantity": 1},
						"unitPricetotalPrice": {
							"value": 3732.99,
							"currency": "R$"
						},
						"originalPriceoptions": [
					{
							"valueindex": 37.99"5",
							"currencyid": "RS5",
						}"name": "AVELA",
						"totalPriceexternalCode": {"4",
							"valueunit": 37.99"UN",
							"currencyquantity": "R$"
1,
						"unitPrice": {
							}"value": 37.99,
							"productionPointcurrency": "Adicional AvelaR$"
					}
				]
			},
		],
		"otherFees": [],
		"discountsoriginalPrice": [{
			{
				"value": 137.99,
							"targetcurrency": "ITEMRS",
				"targetId": "02"		},
						"sponsorshipValuestotalPrice": [{
							{
"value": 37.99,
							"namecurrency": "MARKETPLACE""R$"
						},
						"valueproductionPoint": 10.00 "Adicional Avela"
					}
				]
			}
		],
		"total"otherFees": [],
		"discounts": [
			{
				"itemsvalue": 102.891,
				"otherFeestarget": 38.99"ITEM",
				"discounttargetId": 10.00,
"02",
				"sponsorshipValues": [
					{
						"orderAmountname": 131.88"MARKETPLACE",
						"additionalFeesvalue": 0,10.00
			"deliveryFee": 0
		},
			"payments": {	]
			"prepaid": 0.0,}
			"pending": 0.0],
			"methodstotal": [
				{
					"valueitems": 131102.8889,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"10.00,
					"methodorderAmount": "credit"131.88,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "131.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}

...

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para vários itens acesse a documentação clicando aqui.

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para varios itens com valor integral e adicionais acesse a documentação clicando aqui.

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral, adicionais acesse a documentação clicando aqui.

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para vários itens com um de valor integral e outro com valor fracionando, adicionais e desconto acesse a documentação clicando aqui.

...

05. LINKS
Âncora
links
links

New Order

- Itens Fracionando

Cartão - Item com Valor Integral
New Order Cartão -

Vários

Itens Fracionando

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
varios_itens
varios_itens

04. ERROS
Âncora
erros
erros

05. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave

01. VISÃO GERAL Âncoraver_geralver_geral

02. ENDPOINT Âncoraendpointendpoint

03. EXEMPLO DE UTILIZAÇÃO Âncoravarios_itensvarios_itens

04. ERROS Âncoraerroserros

05. LINKS Âncoralinkslinks

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
varios_itens
varios_itens

04. ERROS
Âncora
erros
erros

05. LINKS
Âncora
links
links