Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

...

Bloco de código
titleJSON da requisição do vários itens no pedido
linenumberstrue
{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"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$"
				}
			},
			{
				"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,
		"delivery": null,
		"prepaidextraInfo": 0.0"Teste",
			"pendingschedule": 0.0null,
			"methodsindoor": [null,
		"takeout": null,
		"table": {
					"valuewaiterCode":  "141.88",
					"currencytableNumber": "BRL8",
					"typechairNumber": "PREPAID1",
		},
			"methodcard": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "141.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}
Nota
titleNota: HTTP Status Code = 200 OK

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

04. ERROS

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

...

null
	}
}
Nota
titleNota: HTTP Status Code = 200 OK

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


...

04. 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
titleJSON Inválido
linenumberstrue
{
	"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

...

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
titleJSON Inválido
linenumberstrue
{
	"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": {
					"idvalue": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e"69.90,
					"namecurrency": "BOTECO DO ALBINOR$"
				},
				"itemsoptionsPrice": [{
			{
				"idvalue": "2"1.00,
					"indexcurrency": "2"R$"
				},
				"nametotalPrice": "A FRANCESA"{
					"value": 69.90,
					"externalCodecurrency": "1",R$"
				}
			},
			{
				"unitid": "UN4",
				"quantityindex": 1"4",
				"specialInstructionsname": "TesteAERADO",
				"unitPriceexternalCode": {"2",
					"valueunit": 69.90"UN",
					"currencyquantity": "R$"1,
				}"specialInstructions": "Teste",
				"optionsPriceunitPrice": {
					"value": 132.0099,
					"currency": "R$"
				},
				"totalPriceoptionsPrice": {
					"value": 6937.9099,
					"currency": "R$"
				}
			},
			{
				"idtotalPrice": "4",{
					"indexvalue": "4"32.99,
					"namecurrency": "AERADOR$",
				"externalCode": "2",}
				"unit": "UN"}
		],
				"quantityotherFees": 1[],
				"specialInstructionsdiscounts": "Teste"[],
				"unitPricetotal": {
					"valueitems": 32102.9989,
					"currencyotherFees": "R$"
				}38.99,
				"optionsPricediscount": {0.00,
					"valueorderAmount": 37141.9988,
			"additionalFees": 0,
			"currencydeliveryFee": "R$"0
				},
				"totalPricepayments": {null,
					"valuedelivery": 32.99null,
					"currencyextraInfo": "R$Teste",
				}
			}
		]"schedule": null,
		"otherFeesindoor": []null,
		"discountstakeout": []null,
		"totaltable": {
			"itemswaiterCode": 102.89,
			"otherFees": 38.99"141.88",
			"discounttableNumber": 0.00,
			"orderAmount": 141.88"8",
			"additionalFeeschairNumber": 0,
			"deliveryFee": 0"1"
		},
		"paymentscard": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods"null
	}
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
				{
					"valuekey":  141.88,
					"currency": "BRL",
		"displayId",
			"typemessage": "PREPAID",body.data.displayId must be a string"
		}
	]
}


...


02. JSON enviando faltando um ou mais campos.

Bloco de código
titleJSON Inválido
linenumberstrue
{
	"integrationHubServiceId			"method": "credit3fea8768-bbd9-454b-9e7b-40841e9a6812",
					"methodInfodata": "Visa",
			{
		"changeForid": 0.0
				}
			]
		}"29261444-5ff8-40b2-bce1-42848247d4a2",
		"deliverytype": null"TABLE",
		"extraInfodisplayId": "Teste8",
		"schedulecreatedAt": null"2024-06-24T17:35:00",
		"indoororderTiming": null"2024-06-24T17:40:24",
		"takeoutpreparationStartDateTime": null"2024-06-24T18:00:00",
		"tableitems": [
			{
				"waiterCodeid": "141.882",
				"tableNumberindex": "82",
				"chairNumbername": "1A FRANCESA",
		},
		"cardexternalCode": null
	}
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{
"1",
				"unit": "UN",
				"quantity": 1,
				"keyspecialInstructions": "displayIdTeste",
				"messageunitPrice": "body.data.displayId must be a string"
		}
	]
}

02. JSON enviando faltando um ou mais campos.

Bloco de código
titleJSON Inválido
linenumberstrue
{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"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"{
					"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,
				"indexspecialInstructions": "2Teste",
				"nameunitPrice": "A FRANCESA",{
					"externalCodevalue": "1"32.99,
					"unitcurrency": "UNR$",
				"quantity": 1},
				"specialInstructionsoptionsPrice": "Teste",
				"unitPrice": {
					"value": 6937.9099,
					"currency": "R$"
				},
				"optionsPricetotalPrice": {
					"value": 132.0099,
					"currency": "R$"
				},
				"totalPrice": {
			
			}
		],
		"valueotherFees": 69.90[],
					"currencydiscounts": "R$"[],
				}
			},
			"total": {
				"iditems": "4"102.89,
				"indexotherFees": "4"38.99,
				"namediscount": "AERADO"0.00,
				"externalCodeorderAmount": "2"141.88,
				"unitadditionalFees": "UN"0,
				"quantitydeliveryFee": 1,0
		},
		"specialInstructionspayments": null,
		"Testedelivery": null,
				"unitPriceextraInfo": {"Teste",
					"valueschedule": 32.99null,
					"currencyindoor": "R$"null,
				}"takeout": null,
				"optionsPricetable": {
					"valuewaiterCode": 37"141.9988",
					"currencytableNumber": "R$8",
				"chairNumber": "1"
		},
		"card": null
	}
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"totalPriceerrors": {[
		{
			"valuekey": 32.99"merchant",
					"currencymessage": "R$body.data.merchant is required"
				}
				
			}
		],
		"otherFees": [],
		"discounts": [],
		"total": {
			"items": 102.89,
			"otherFees": 38.99,
			"discount": 0.00,
			"orderAmount": 141.88,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value":  141.88,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "141.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{
			"key": "merchant",
			"message": "body.data.merchant is required"
		}
	]
}

...

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
titleNota: 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
titleURL enviada incorreda
https://api-barramento.meuelevestage.com/order/newOrderS

...

titleJSON Response para URL incorreta
linenumberstrue

...

]
}


...


  • 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
titleNota: HTTP Status Code = 403 - Forbidden401 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 novamenteO cliente não enviou uma requisição para a URL  incorreta.


...


  • HTTP Status Code 404 403 - Not FoundForbidden
    Â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álido.o servidor não entendeu a requisição do cliente por está tentando acessar uma URL incorreta.

Bloco de código
titleURL enviada incorreda
https://api-barramento.meuelevestage.com/order/newOrderS
Bloco de código
titleIntegration Hub Code InválidoJSON Response para URL incorreta
linenumberstrue
{
	"integrationHubServiceId": "709aa0b2-2b89-4d06-9f12-c3b8c275d9fa",
	"datamessage": "Missing Authentication Token"
}
Nota
titleNota: 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
titleIntegration Hub Code Inválido
linenumberstrue
{
	"integrationHubServiceId": "709aa0b2-2b89-4d06-9f12-c3b8c275d9fa",
	"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": "c312d2ff29261444-1a8f5ff8-40ad40b2-8eedbce1-9ae9a908df6e42848247d4a2",
			"nametype": "BOTECO DO ALBINOTABLE",
		}"displayId": "8",
		"itemscreatedAt": [
			{
				"id"2024-06-24T17:35:00",
		"orderTiming": "22024-06-24T17:40:24",
				"indexpreparationStartDateTime": "22024-06-24T18:00:00",
				"namemerchant": "A FRANCESA",
	{
			"externalCodeid": "1c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
				"unitname": "UNBOTECO DO ALBINO",
		},
		"quantityitems": 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$"
				},
			}
		],
		"otherFeesoptionsPrice": [],{
					"discountsvalue": []37.99,
		"total": {
			"itemscurrency": 102.89,"R$"
			"otherFees": 38.99	},
				"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": {
			"waiterCode": "141.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}

...