Histórico da Página

CONTEÚDO - NÃO MEXE API

...

Esta documentação tem como finalidade demonstrar o formato JSON para envio de requisições de pedidos com vários itens na API Order MesaCartão Consumo, utilizando o endpoint newOrder.

...

02

...

.

...

EXEMPLO DE UTILIZAÇÃO
Âncora
varios_itens
varios_itens

2.1. Request Vários 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-40841e9a6812",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLECARD",
		"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$"
				}
			},
			{
				"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$"
				}
			}
		],
		"otherFees": [],
		"discounts": [],
		"total": {
			"items": 102.89,
			"otherFees": 38.99,
			"discount": 0.00,
			"orderAmount": 141.88,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {null,
			"prepaiddelivery": 0.0null,
			"pendingextraInfo": 0.0"Teste",
			"methodsschedule": [null,
				{"indoor": null,
					"valuetakeout":  141.88null,
					"currencytable": "BRL"null,
					"typecard": "PREPAID",{
					"methodwaiterCode": "credit"9999,
					"methodInfocardNumber": "Visa"29,
					"changeFordeliveryTableNumber": 0.029
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "141.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.

...

03. ERROS
Âncora
erros
erros

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

...

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

3.1 - Formato inválido do JSON esperado:

A requisição foi enviada com um JSON malformado ou inválido, o que impede o sistema de interpretá-la corretamente. Isso ocorre quando a estrutura JSON contém erros de sintaxe, como chaves ou colchetes incorretos.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812a40841e9a6812",
	"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"CARD",
		"merchantdisplayId": {8,
			"idcreatedAt": "c312d2ff2024-1a8f-40ad-8eed-9ae9a908df6e06-24T17:35:00",
			"nameorderTiming": "BOTECO DO ALBINO"
		}2024-06-24T17:40:24",
		"itemspreparationStartDateTime": [
			{
				"id": "2"2024-06-24T18:00:00",
				"indexmerchant": "2",{
				"nameid": "A FRANCESAc312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
				"externalCodename": "1BOTECO DO ALBINO",
		},
		"unititems": "UN",[
				"quantity": 1,{
				"specialInstructionsid": "Teste2",
				"unitPriceindex": {"2",
					"valuename": 69.90 "A FRANCESA",
					"currencyexternalCode": "R$"
				}1",
				"optionsPriceunit": {"UN",
					"valuequantity": 1.00,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
			},
				"optionsPrice": {
					"idvalue": "4"1.00,
					"indexcurrency": "4"R$"
				},
				"nametotalPrice": "AERADO",{
					"externalCodevalue": "2"69.90,
					"unitcurrency": "UNR$",
				}
			"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$"
				}
			}
		],
		"otherFees": [],
		"discountsoptionsPrice": [],
		"total": {
			"items": 102.89,
			"otherFeesvalue": 3837.99,
					"discountcurrency": 0.00"R$"
				},
				"orderAmounttotalPrice": 141.88,
{
					"additionalFeesvalue": 032.99,
					"deliveryFeecurrency": 0"R$"
				},
			"payments": {}
			"prepaid": 0.0],
			"pendingotherFees": 0.0[],
			"methodsdiscounts": [],
				"total": {
					"valueitems":  141102.8889,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"0.00,
					"methodorderAmount": "credit"141.88,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				}
			]},
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": null,
		"card": {
			"waiterCode": "141.88"9999,
			"tableNumbercardNumber": "8"29,
			"chairNumberdeliveryTableNumber": "1"29
		},
		"card": null 
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "displayId",
			"message": "body.data.displayId must be a string"
		}
	]
}

...

3.

...

2 - JSON enviado com a ausência de um ou mais campos obrigatórios:

Se a requisição estiver faltando um ou mais campos obrigatórios, o servidor responderá com um erro 400. Cada campo requerido deve estar presente para que a operação seja processada corretamente.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLECARD",
		"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$"
				},
				"optionsPriceunitPrice": {
					"value": 169.0090,
					"currency": "R$"
				},
				"totalPriceoptionsPrice": {
					"value": 691.9000,
					"currency": "R$"
				}
			},
			{
				"idtotalPrice": "4",{
					"indexvalue": "4"69.90,
					"namecurrency": "AERADOR$",
				"externalCode": "2",}
				"unit": "UN"},
				"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$"
				}				

				},
		],
		"otherFeesoptionsPrice": [],{
					"discountsvalue": []37.99,
		"total": {
			"itemscurrency": 102.89,"R$"
			"otherFees": 38.99	},
				"discounttotalPrice": 0.00,{
					"orderAmountvalue": 14132.8899,
			"additionalFees": 0,
			"deliveryFeecurrency": 0"R$"
				},
		"payments": {	}
		],
		"prepaidotherFees": 0.0[],
			"pendingdiscounts": 0.0[],
			"methodstotal": [
				{
					"valueitems":  141102.8889,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"0.00,
					"methodorderAmount": "credit"141.88,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {null,
			"waiterCodecard": "141.88",{
			"tableNumberwaiterCode": "8"9999,
			"chairNumbercardNumber": "1"
		}29,
			"carddeliveryTableNumber": null29
		} 
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "merchant",
			"message": "body.data.merchant is required"
		}
	]
}

...

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	true

{
	"integrationHubServiceId": "709aa0b2-2b89-4d06-9f12-c3b8c275d9fa{
	"integrationHubServiceId": "709aa0b2-2b89-4d06-9f12-c3b8c275d9fa",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLE",
		"displayId": "8",
		"createdAtdata": "2024-06-24T17:35:00",{
		"orderTimingid": "2024-06-24T17:40:2429261444-5ff8-40b2-bce1-42848247d4a2",
		"preparationStartDateTimetype": "2024-06-24T18:00:00",
		"merchant": {CARD",
			"iddisplayId": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e8",
			"namecreatedAt": "BOTECO DO ALBINO"
		}2024-06-24T17:35:00",
		"itemsorderTiming": ["2024-06-24T17:40:24",
			{
				"id"preparationStartDateTime": "22024-06-24T18:00:00",
				"indexmerchant": "2",{
				"nameid": "A FRANCESAc312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
				"externalCodename": "1BOTECO DO ALBINO",
		},
		"unititems": "UN",[
				"quantity": 1,{
				"specialInstructionsid": "Teste2",
				"unitPriceindex": {
					"value": 69.90"2",
					"currencyname": "R$A FRANCESA",
				}"externalCode": "1",
				"optionsPriceunit": {"UN",
					"valuequantity": 1.00,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 69.90,
					"currency": "R$"
				}
			},
			{
				"idoptionsPrice": "4",
				"index": "4",{
					"namevalue": "AERADO"1.00,
					"externalCodecurrency": "2"R$"
				},
				"unittotalPrice": "UN",{
					"quantityvalue": 169.90,
					"specialInstructionscurrency": "Teste"R$"
				}
			},
			{
				"unitPriceid": {"4",
					"valueindex": 32.99"4",
					"currencyname": "R$AERADO",
				}"externalCode": "2",
				"optionsPriceunit": {"UN",
					"valuequantity": 37.991,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 32.99,
					"currency": "R$"
				}
			}
		],
		"otherFeescurrency": [],
		"discounts": [],
		"total"R$"
				},
				"optionsPrice": {
					"itemsvalue": 10237.8999,
					"otherFeescurrency": 38.99"R$"
				},
				"discounttotalPrice": 0.00,{
					"orderAmountvalue": 14132.8899,
					"additionalFeescurrency": 0,"R$"
				"deliveryFee": 0
}
			},
		"payments": {
	],
		"prepaidotherFees": 0.0[],
			"pendingdiscounts": 0.0[],
			"methodstotal": [
				{
					"valueitems":  141102.8889,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"0.00,
					"methodorderAmount": "credit"141.88,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {null,
			"waiterCodecard": "141.88",{
			"tableNumberwaiterCode": "8"9999,
			"chairNumbercardNumber": "1"29,
		},
		"carddeliveryTableNumber": null29
		} 
	}
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"709aa0b2-2b89-4d06-9f12-c3b8c275d9fa\" not found or disabled"
		}
	]
}

...

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 item com valor integral, adicionais e descontos 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 item itens com valor integral e um fracionado, adicionais e descontos acesse a documentação clicando aqui.

...

04. LINKS
Âncora
links
links

New Order

Mesa - 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 1

Nova versão Atual

Chave

02

.

EXEMPLO DE UTILIZAÇÃO
Âncora
varios_itens
varios_itens

03. ERROS
Âncora
erros
erros

04. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

02

.

EXEMPLO DE UTILIZAÇÃO Âncoravarios_itensvarios_itens

03. ERROS Âncoraerroserros

04. LINKS Âncoralinkslinks

EXEMPLO DE UTILIZAÇÃO
Âncora
varios_itens
varios_itens

03. ERROS
Âncora
erros
erros

04. LINKS
Âncora
links
links