TOTVS Food Service

Páginas filhas
  • New Order Mesa - Vários Itens

Versões comparadas

Versão antiga 8

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

Chave

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

...

...

02. ENDPOINT
Âncora
endpoint
endpoint


MétodoURL
POSThttps://api-barramento.meuelevestage.com/order/newOrder


...

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

...

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,
			"prepaiddelivery": 0.0null,
			"pendingextraInfo": 0.0"Teste",
			"methodsschedule": [null,
				{"indoor": null,
					"valuetakeout":  141.88null,
		"table": {
			"currencywaiterCode": "BRL141.88",
					"typetableNumber": "PREPAID8",
					"methodchairNumber": "credit1",
					"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
Âncora
erros
erros

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

...

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",
		"merchantdisplayId": {8,
			"idcreatedAt": "c312d2ff2024-1a8f-40ad-8eed-9ae9a908df6e06-24T17:35:00",
			"nameorderTiming": "BOTECO DO ALBINO"
		}2024-06-24T17:40:24",
		"itemspreparationStartDateTime": [
			{
				"id": "2",
				"index": "2",
	"2024-06-24T18:00:00",
		"merchant": {
			"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"optionsPrice": [],{
					"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
	}
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{",
			"keytableNumber": "displayId8",
			"messagechairNumber": "body.data.displayId must be a string1"
		},
		"card": null
	]}
}

...

 Bloco de código
titleJSON InválidoResposta 
linenumberstrue
{
	"integrationHubServiceIderrors": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
[
		{
			"idkey": "29261444-5ff8-40b2-bce1-42848247d4a2displayId",
			"typemessage": "TABLE",body.data.displayId must be a string"
		}
	]
}

...

02. JSON enviando faltando um ou mais campos.
 Bloco de código
titleJSON Inválido
linenumberstrue
{
	"integrationHubServiceId"displayId": "8",
		"createdAt": "2024-06-24T17:35:003fea8768-bbd9-454b-9e7b-40841e9a6812",
		"orderTimingdata": "2024-06-24T17:40:24",{
		"preparationStartDateTimeid": "2024-06-24T18:00:0029261444-5ff8-40b2-bce1-42848247d4a2",
		"itemstype": [
			{
				"id": "2",
		"TABLE",
		"indexdisplayId": "28",
				"namecreatedAt": "A FRANCESA2024-06-24T17:35:00",
				"externalCodeorderTiming": "12024-06-24T17:40:24",
				"unitpreparationStartDateTime": "UN2024-06-24T18:00:00",
				"quantityitems": 1,[
				"specialInstructions": "Teste",{
				"unitPriceid": {"2",
					"valueindex": 69.90"2",
					"currencyname": "R$A FRANCESA",
				}"externalCode": "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": [],
		"discounts": []	},
				"totaloptionsPrice": {
					"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": {
			"waiterCode": "141.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}
...
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
...
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": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 1,
				"specialInstructionsexternalCode": "Teste1",
				"unitPriceunit": {"UN",
					"valuequantity": 69.901,
					"currencyspecialInstructions": "R$"
				}Teste",
				"optionsPriceunitPrice": {
					"value": 169.0090,
					"currency": "R$"
				},
				"totalPriceoptionsPrice": {
					"value": 691.9000,
					"currency": "R$"
				}
			},
			{
				"idcurrency": "4R$",
				"index": "4"},
				"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": [],
		"discounts": [],
				"totaloptionsPrice": {
					"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": {
			"waiterCode": "141.88",
			"tableNumber": "8",
			"chairNumber": "1"
		},
		"card": null
	}
}
...
 Dica
titleSaiba 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 adcional  acesse a documentação clicando aqui.
 Dica
titleSaiba 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 e descontos  acesse a documentação clicando aqui.
 Dica
titleSaiba 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 um com valor integral outro fracionado, adicionais e descontos  acesse a documentação clicando aqui.
...

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


 Templatedocumentos