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 item fracionando na API Order MesaCartão Consumo, utilizando o endpoint newOrder. Para pedidos com itens fracionandos.

...

.

...

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

2.1 - Request Itens Fracionando:

Ao enviar a requisição para este endpoint, o sistema processa a criação de um novo pedido, incluindo itens de valor integral

Estrutura do corpo da requisição para criação de Estrutura do corpo da requisição para criação de novos pedidos, incluindo itens com valor 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,
				{
					"valueindoor": 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.

...

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:

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.

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

...

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": "8964f5fb-db7a-4ce4-86d3-47990aa481df			"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"scheduletype": null"CARD",
		"indoordisplayId": null"5",
		"takeoutcreatedAt": null"2024-06-24T17:35:00",
		"tableorderTiming": {
			"waiterCode": "9999"2024-06-24T17:40:24",
			"tableNumberpreparationStartDateTime": "54",
	2024-06-24T18:00:00",
		"chairNumberitems": "1"[
			},{
				"cardid": null
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
"5",
				"keyindex": "displayId5",
				"messagename": "body.data.displayId must be a string"MARACUJA",
		}
	]
}

02. JSON enviando faltando um ou mais campos.

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceIdexternalCode": "3fea8768-bbd9-454b-9e7b-40841e9a6812c58",
				"dataunit": {
"UN",
				"idquantity": "fa3a2d45-3a29-4136-95e7-692d93db8b2b"0.5,
				"typespecialInstructions": "TABLETeste",
				"displayIdunitPrice": "55",
{
					"createdAtvalue": "2024-06-24T17:35:00"61.00,
					"orderTimingcurrency": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",		
		"items": [
			{
"R$"
				},
				"optionsPrice": {
					"idvalue": "54"0.0,
					"indexcurrency": "54R$",
				"name": "MARACUJA"},
				"externalCodetotalPrice": "58"{
					"value": 30.50,
					"unitcurrency": "UNR$",
				}
			"quantity": 1.0,}
		],
		"specialInstructionsotherFees": "Teste"[],
				"unitPricetotal": {
					"valueitems": 6130.0050,
					"currencyotherFees": "R$"0,
				}"discount": 0.0,
				"optionsPriceorderAmount": {
		30.50,
			"valueadditionalFees": 0.0,
					"currencydeliveryFee": "R$"0
				},
				"totalPricepayments": {null,
					"valuedelivery": 61.00null,
					"currencyextraInfo": "R$Teste",
				}
			}
		],
		"otherFees"schedule": []null,
		"totalindoor": {null,
			"itemstakeout": 61.0null,
			"otherFeestable": 0null,
			"discountcard": 0.0,{
			"orderAmountwaiterCode": 61.09999,
			"additionalFeescardNumber": 029,
			"deliveryFeedeliveryTableNumber": 029
		},
		"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.

...

}
}

Bloco de código

title	JSON Resposta
linenumbers	true

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

Nota

title	Nota: HTTP Status Code = 401 Unauthorized400 Bad Request

A solicitação é inválida e não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente.

...

HTTP Status Code 403 401 - ForbiddenUnauthorized
Âncora
status_code_
403
401
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
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.

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 - ForbiddenHTTP Status Code 404 - Not Found
Âncora
status_code_404403
status_code_404403

O código de status HTTP 404403, conhecido como "Not FoundForbidden" (Não EncontradoProibido), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o integrationHubId está incorreto ou inválidoentendeu a requisição do cliente por está tentando acessar uma URL incorreta.

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true
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.

...

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": {
{
	"integrationHubServiceId": "f1b874af-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",
		"merchant": {
			"id": "c312d2ff8964f5fb-1a8fdb7a-40ad4ce4-8eed86d3-9ae9a908df6e47990aa481df",
			"nametype": "BOTECO DO ALBINO"
		}CARD",
		"itemsdisplayId": [
			{
		"5",
		"idcreatedAt": "542024-06-24T17:35:00",
				"indexorderTiming": "542024-06-24T17:40:24",
				"namepreparationStartDateTime": "MARACUJA2024-06-24T18:00:00",
		"merchant": {
			"externalCodeid": "58c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
				"unitname": "UNBOTECO DO ALBINO",
		},
		"quantityitems": 1.0,[
			{
				"specialInstructionsid": "Teste5",
				"unitPriceindex": {"5",
					"valuename": 61.00"MARACUJA",
					"currencyexternalCode": "R$"
				}58",
				"optionsPrice": {
	unit": "UN",
				"valuequantity": 0.05,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"totaloptionsPrice": {
			"items": 61.0,
			"otherFees": 0,
			"discountvalue": 0.0,
					"orderAmountcurrency": 61.0"R$"
				},
				"additionalFeestotalPrice": 0,{
					"deliveryFeevalue": 030.50,
			},
		"paymentscurrency": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 61.0,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		}"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",
			"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 fracionado 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 fracionados, adicionais e descontos acesse a documentação clicando aqui.

...

04. LINKS
Âncora
links
links

New Order Cartão -

Itens Fracionando

Item com Valor Integral
New Order Cartão- Vários Itens

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

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

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

03. EXEMPLO DE UTILIZAÇÃO Âncorapedido_fracionandopedido_fracionando

03. ERROS Âncoraerroserros

04. LINKS Âncoralinkslinks

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

03. ERROS
Âncora
erros
erros

04. LINKS
Âncora
links
links