Histórico da Página

...

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

...

02. ENDPOINT
Âncora
endpoint
endpoint

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

...

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

...

Bloco de código

title	JSON para pedido com inteiro
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "8964f5fb-db7a-4ce4-86d3-47990aa481df",
		"type": "TABLECARD",
		"displayId": "5",
		"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": "5",
				"index": "5",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 30.50,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"total": {
			"items": 30.50,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 30.50,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {null,
			"prepaiddelivery": 0.0null,
			"pendingextraInfo": 0.0"Teste",
			"methodsschedule": [null,
				{
					"value"indoor": 30.50null,
					"currencytakeout": "BRL"null,
					"typetable": "PREPAID"null,
		"card": {
			"methodwaiterCode": "credit"9999,
					"methodInfocardNumber": "Visa"29,
					"changeFordeliveryTableNumber": 0.029
				} 
			]}
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "9999",
			"tableNumber": "5",
			"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.

...

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

...

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:

HTTP Status Code - 400 - Bad Request
Âncora
status_code_400
status_code_400

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 inválido do JSON esperado.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "8964f5fb-db7a-4ce4-86d3-47990aa481df",
		"type": "CARD",
		"displayId": 5,
		"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": [
			{

...

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 inválido do JSON esperado.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "b1e26dd8-0a1b-486e-bf62-65e80ddce2f45",
				"typeindex": "TABLE5",
				"displayIdname": 55"MARACUJA",
				"createdAtexternalCode": "2024-06-24T17:35:00",
58",
				"orderTimingunit": "2024-06-24T17:40:24UN",
				"preparationStartDateTimequantity": "2024-06-24T18:00:00"0.5,
		"merchant": {
			"idspecialInstructions": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6eTeste",
				"nameunitPrice": "BOTECO DO ALBINO"
{
			},
		"itemsvalue": [
			{
61.00,
					"idcurrency": "54"R$"
				},
				"indexoptionsPrice": "54",{
					"namevalue": "MARACUJA"0.0,
					"externalCodecurrency": "58R$",
				"unit": "UN"},
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPricetotalPrice": {
					"value": 6130.0050,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"optionsPricetotal": {
					"valueitems": 030.050,
					"currencyotherFees": "R$"
				}0,
				"totalPricediscount": {
		0.0,
			"valueorderAmount": 6130.0050,
					"currencyadditionalFees": "R$"0,
				}
	"deliveryFee": 0
		}
		],
		"otherFeespayments": []null,
		"totaldelivery": {null,
			"itemsextraInfo": 61.0,
			"otherFees": 0"Teste",
			"discountschedule": 0.0null,
			"orderAmountindoor": 61.0null,
			"additionalFeestakeout": 0null,
			"deliveryFeetable": 0
		}null,
		"paymentscard": {
			"prepaidwaiterCode": 0.09999,
			"pendingcardNumber": 0.029,
			"methodsdeliveryTableNumber": [29
				{
					"value": 61.0,
		} 
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"currencykey": "BRLdisplayId",
					"typemessage": "PREPAID",body.data.displayId must be a string"
		}
	]
}

...

02. JSON enviando faltando um ou mais campos.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId			"method": "credit3fea8768-bbd9-454b-9e7b-40841e9a6812",
			"data": {
		"methodInfoid": "Visa8964f5fb-db7a-4ce4-86d3-47990aa481df",
					"changeFortype": 0.0
				}
			]
		}"CARD",
		"deliverydisplayId": null"5",
		"extraInfocreatedAt": "Teste2024-06-24T17:35:00",
		"scheduleorderTiming": null,
		"indoor": null"2024-06-24T17:40:24",
		"takeoutpreparationStartDateTime": null"2024-06-24T18:00:00",
		"tableitems": [
			{
				"waiterCodeid": "99995",
				"tableNumberindex": "545",
				"chairNumbername": "1MARACUJA",
		},
		"cardexternalCode": null
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
"58",
				"unit": "UN",
				"quantity": 0.5,
				"keyspecialInstructions": "displayIdTeste",
				"messageunitPrice": "body.data.displayId must be a string{
					"value": 61.00,
					"currency": "R$"
				},
	]
}

02. JSON enviando faltando um ou mais campos.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812c",
	"data": {
		"id": "fa3a2d45-3a29-4136-95e7-692d93db8b2b",
		"type": "TABLE",
		"displayId": "55",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",		
		"items": [
			{
				"id": "54",
				"index": "54",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"total": {
			"items": 61.0,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 61.0,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 61.0,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "9999",
			"tableNumber": "54",
			"chairNumber": "1"
		},
		"card": null
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

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

Nota

title	Nota: HTTP Status Code = 400 Bad Request

A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente.

...

				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 30.50,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"total": {
			"items": 30.50,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 30.50,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": null,
		"card": {
			"waiterCode": 9999,
			"cardNumber": 29,
			"deliveryTableNumber": 29
		} 
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

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

Nota

title	Nota: HTTP Status Code = 400 Bad Request

A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente.

...

HTTP Status Code 401 - Unauthorized
Âncora
status_code_401
status_code_401

O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

Nota

title	Nota: HTTP Status Code = 401 Unauthorized

A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente.

...

HTTP Status Code 403 - Forbidden
Âncora
status_code_403
status_code_403

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	JSON Response para URL incorreta

...

O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

Nota

title	Nota: HTTP Status Code = 401 Unauthorized

A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente.

...

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	JSON Response para URL incorreta
linenumbers	true

{
	"message": "Missing Authentication Token"
}

Nota

title	Nota: HTTP Status Code = 403 - Forbidden

O cliente não enviou uma requisição para a URL incorreta.

...

O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId está incorreto ou inválido.

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true

{
	"integrationHubServiceIdmessage": "Missing Authentication Token"
}

Nota

title	Nota: HTTP Status Code = 403 - Forbidden

O cliente não enviou uma requisição para a URL incorreta.

...

HTTP Status Code 404 - Not Found
Âncora
status_code_404
status_code_404

O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId está incorreto ou inválido.

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true

{
	"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	"data": {
		"id": "8964f5fb-db7a-4ce4-86d3-47990aa481dff1b874af-96ab-4535-aac3-25118fe586cc2",
	"data": {
		"id": "f1bddb3f-63c4-4b2f-be53-e4527275ad9d",
		"type": "TABLE",
		"displayId": "55",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchanttype": {"CARD",
			"iddisplayId": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e "5",
			"namecreatedAt": "BOTECO DO ALBINO"
		}2024-06-24T17:35:00",
		"itemsorderTiming": [
			{
				"id"2024-06-24T17:40:24",
		"preparationStartDateTime": "542024-06-24T18:00:00",
		
		"indexmerchant": "54",{
				"nameid": "MARACUJAc312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
				"externalCodename": "58BOTECO DO ALBINO",
		},
		"unititems": "UN",[
				"quantity": 1.0,{
				"specialInstructionsid": "Teste5",
				"unitPriceindex": {"5",
					"valuename": 61.00"MARACUJA",
					"currencyexternalCode": "R$"
				}58",
				"optionsPriceunit": {"UN",
					"valuequantity": 0.05,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"totaloptionsPrice": {
					"itemsvalue": 610.0,
					"otherFeescurrency": 0,"R$"
				"discount": 0.0},
				"orderAmounttotalPrice": 61.0,
{
					"additionalFeesvalue": 030.50,
					"deliveryFeecurrency": 0"R$"
				},
			"payments": {
			"prepaid": 0.0,
	}
		],
		"pendingotherFees": 0.0[],
			"methodstotal": [
				{
					"valueitems": 6130.050,
					"currencyotherFees": "BRL"0,
					"typediscount": "PREPAID"0.0,
					"methodorderAmount": "credit"30.50,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": null,
		"card": {
			"waiterCode": "9999",
			"tableNumbercardNumber": "54"29,
			"chairNumberdeliveryTableNumber": "1"29
		},
		"card": null 
	}
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" 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 itens fracionados, adicionais e descontos acesse a documentação clicando aqui.

...

05. LINKS
Âncora
links
links

New Order Cartão - Itens Fracionando
New Order - Vários Itens

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

02. ENDPOINT
Âncora
endpoint
endpoint

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

04. ERROS
Âncora
erros
erros

05. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

02. ENDPOINT Âncoraendpointendpoint

03. EXEMPLO DE UTILIZAÇÃO Âncorapedido_fracionandopedido_fracionando

04. ERROS Âncoraerroserros

05. LINKS Âncoralinkslinks

02. ENDPOINT
Âncora
endpoint
endpoint

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

04. ERROS
Âncora
erros
erros

05. LINKS
Âncora
links
links