Histórico da Página

...

Bloco de código

title	JSON para pedido com inteiro
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "f4114e16-c2e4-4dc3-86f3-98a52bfd5d7d",
		"type": "TABLECARD",
		"displayId": "58",
		"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": "61",
				"index": "60",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				 "options": [
          {
            					{
						"index": "61",
            						"id": "61",
						"name":            "name"COMPOSICAO A",
						"externalCode": "COMPOSICAO A201",
            "externalCode						"unit": "201UN",
            "unit						"quantity": "UN",
            "quantity": 1,
            1,
						"unitPrice": {
              							"value": 1.00,
              "currency": "R$"
            },
            							"currency": "R$"
						},
						"originalPrice": {
              "value": 1.00,
              							"value": 1.00,
							"currency": "R$"
            						},
            "totalPrice": {
              "						"totalPrice": {
							"value": 1.00,
              							"currency": "R$"
            },
            						},
						"productionPoint": "Teste"
          }
        					}
				]
			}
		],
		"otherFees": [],
		"total": {
			"items": 70.90,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 70.90,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 70.90,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": null,
		"card": {
			"waiterCode": "9999",
			"tableNumbercardNumber": "57"29,
			"chairNumberdeliveryTableNumber": "1"29
		},
		"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.

...

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "b1e26dd8f4114e16-0a1bc2e4-486e4dc3-bf6286f3-65e80ddce2f498a52bfd5d7d",
		"type": "TABLECARD",
		"displayId": 5558,
		"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": "5461",
				"index": "5460",
				"name": "MARACUJAA FRANCESA",
				"externalCode": "581",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 6169.0090,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 6169.0090,
					"currency": "R$"
				},
			}
		],
		"otherFeesoptions": [],
		"total": 			{
						"itemsindex": "61.0",
						"otherFeesid": 0"61",
						"discountname": 0.0"COMPOSICAO A",
						"orderAmountexternalCode": 61.0"201",
						"additionalFeesunit": 0"UN",
						"deliveryFeequantity": 01,
		},
				"paymentsunitPrice": {
							"prepaidvalue": 01.000,
							"pendingcurrency": 0.0,
"R$"
						},
						"methodsoriginalPrice": [{
				{
					"value": 611.000,
							"currency": "BRL"R$"
						},
						"typetotalPrice": "PREPAID",{
							"methodvalue": "credit"1.00,
							"methodInfocurrency": "Visa"R$"
						},
						"changeForproductionPoint": 0.0"Teste"
					}
				]
			}
		],
		"deliveryotherFees": null[],
		"extraInfototal": "Teste",{
			"scheduleitems": null70.90,
			"indoorotherFees": null0,
			"takeoutdiscount": null0.0,
			"tableorderAmount": {70.90,
			"waiterCodeadditionalFees": "9999"0,
			"tableNumberdeliveryFee": "54"0
		},
			"chairNumberpayments": "1"{
		}	"prepaid": 0.0,
			"cardpending": null
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors0.0,
			"methods": [
				{
					"keyvalue": "displayId"70.90,
					"messagecurrency": "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": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "fa3a2d45-3a29-4136-95e7-692d93db8b2b",
		"type": "TABLE",
		"displayId": "55BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"createdAtschedule": "2024-06-24T17:35:00"null,
		"orderTimingindoor": "2024-06-24T17:40:24",null,
		"preparationStartDateTimetakeout": "2024-06-24T18:00:00",		null,
		"itemstable": [null,
			{
				"id"card": "54",{
				"indexwaiterCode": "54"9999,
				"namecardNumber": "MARACUJA"29,
				"externalCodedeliveryTableNumber": "58",29
		} 
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"uniterrors": "UN",[
				"quantity": 1.0,{
				"specialInstructionskey": "TestedisplayId",
				"unitPricemessage": {
					"value": 61.00,"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		"currency": "R$"
				}3fea8768-bbd9-454b-9e7b-40841e9a6812",
				"optionsPricedata": {
					"valueid": 0.0,
					"currency""f4114e16-c2e4-4dc3-86f3-98a52bfd5d7d",
		"type": "R$"
				}CARD",
				"totalPricedisplayId": {"58",
					"valuecreatedAt": 61.00"2024-06-24T17:35:00",
					"currencyorderTiming": "R$"
				}
			}
		]2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"otherFeesitems": [],
			"total": {
				"itemsid": "61.0",
				"otherFeesindex": 0"60",
				"discountname": 0.0"A FRANCESA",
				"orderAmountexternalCode": 61.0"1",
				"additionalFeesunit": 0"UN",
				"deliveryFeequantity": 01,
		},
		"paymentsspecialInstructions": {"Teste",
				"prepaidunitPrice": 0.0,
{
					"pendingvalue": 069.090,
					"methodscurrency": ["R$"
				},
				"optionsPrice": {
					"value": 610.0,
					"currency": "BRL"R$"
				},
					"typetotalPrice": "PREPAID",{
					"methodvalue": "credit"69.90,
					"methodInfocurrency": "Visa"R$"
				},
					"changeForoptions": 0.0[
					}{
			]
		},
		"deliveryindex": null"61",
						"extraInfoid": "Teste61",
						"schedulename": null"COMPOSICAO A",
						"indoorexternalCode": null"201",
						"takeoutunit": null"UN",
						"tablequantity": {1,
						"waiterCodeunitPrice": "9999",{
							"tableNumbervalue": "54"1.00,
							"chairNumbercurrency": "1R$"
						},
						"cardoriginalPrice": null{
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
							"value": 1.00,
							"keycurrency": "merchant"R$"
						},
						"messagetotalPrice": "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.

...

{
							"value": 1.00,
							"currency": "R$"
						},
						"productionPoint": "Teste"
					}
				]
			}
		],
		"otherFees": [],
		"total": {
			"items": 70.90,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 70.90,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 70.90,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"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
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": {
		"id": "f4114e16-c2e4-4dc3-86f3-98a52bfd5d7d",
		"type": "CARD",
		"displayId": "58",
		"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": "61",
				"index": "60",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"options": [
					{
						"index": "61",
						"id": "61",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {

...

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

{
	"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	"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": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "54",
				"index": "54",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 611.00,
							"currency": "R$"
						},
						"optionsPricetotalPrice": {
							"value": 01.000,
							"currency": "R$"
				},
				"totalPrice": {"
					"value": 61.00	},
						"currencyproductionPoint": "R$Teste"
					}
				]
			}
		],
		"otherFees": [],
		"total": {
			"items": 6170.090,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 6170.090,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 6170.090,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"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 com valor integral, adicionais, descontos e taxa acesse a documentação clicando aqui.

...

05. LINKS
Âncora
links
links

New Order - Itens Fracionando
New Order - Vários Itens

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

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

05. LINKS Âncoralinkslinks

05. LINKS
Âncora
links
links