TOTVS Food Service

Páginas filhas
  • API Order Mesa - Get Status

Versões comparadas

Versão antiga 54

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

Gravado em

comparado com

Nova versão 55

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

Gravado em

Chave

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

...

...

Este endpoint é utilizado para obter informações detalhadas sobre os pedidos, fornecendo um retorno em formato JSON com diversos atributos relevantes. Ao enviar uma solicitação no formato especificado, como nos exemplos abaixo, o endpoint processa a requisição e retorna um conjunto de dados que inclui o status mais recente do pedido, a identificação do serviço, a chave do pedido e detalhes específicos de cada item relacionado ao pedido.

Obtenha o status atribuído a um ou mais pedidos utilizando o parâmetro orderKeyType, que pode ser ORDER_ID, TABLE ou CARD.

...


...

02. ENDPOINT
Âncora
endpoint
endpoint


MétodoURLAmbiente
POSThttps://api-barramento.meuelevestage.com/order/getStatusHomologação

...

MétodoURL
POSThttps://api-barramento.
meuelevestage
meueleve.com.br/order/getStatusProdução


...

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

3.1 - Request - Obter detalhes de um pedido específico: Essa requisição é utilizada para buscar informações detalhadas sobre um pedido específico:

Âncora
detalhes_pedido_especifico
detalhes_pedido_especifico
01. Retornar todos os estados dos pedidos:  Âncoratodos_statustodos_status

Bloco de código
titleJSON Para retornar o status de todos os pedidosum pedido específico
linenumberstrue
{
  "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType": "TABLE",
  "orderKey": ["40"]
}
Bloco de códigonote
titleResposta do JSON da requisição
linenumberstrue
Nota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.


...


3.2 - Request - Ao reenviar a solicitação, a resposta será a seguinte: Ao reenviar a requisição, você receberá uma resposta contendo o status atualizado e os detalhes do pedido.

Bloco de código
titleJSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_40"
		}
	]
}  
Nota
titleNota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.


...


3.3 - Request - Reenvio da solicitação, resposta de processamento: Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento. 

Bloco de código
titleJSON de resposta do retorno de um pedido
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "1853f0ab-faf7-47d6-a193-610b20807143",
	"orderKeyType": "TABLE",
	"orderKey": [
		"40"
	],
	"lastestUpdatedStatus": "2024-06-28 09:04:06",
	"items": [{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "TABLE",
	"orderKey": [],
	"lastestUpdatedStatus": "2024-07-03 17:18:42",
	"items": [
		{
			"id": "fd8654cf-ca3d-440c-b34e-c7936cbbd1fd",
			"status": {
				"code": 506,
				"description": "CLOSED_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "1"
		},
		{
			"id": "f08549f8-c82f-4d29-8955-25bc9f15c84a",
			"status": {
				"code": 506,
				"description": "CLOSED_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "2"
		},
		{
			"id": "d19436e450425147-99da5d06-45934b87-a92aa05b-46125f076e124586f2dccc71",
			"status": {
				"code": 504505,
				"description": "OPENTABLE_IN_TABLEUSE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "340"
		},
		{
			"id": "05bc9478-60cc-43b3-87bb-6f9a1d0cf295"]
}
Nota
titleNota: HTTP Status Code = 226 IM Used

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.


...

3.4 - Request - Retornar o status de múltiplos pedidos: Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido

Âncora
multiplos
multiplos

Bloco de código
titleJSON Para retornar múltiplos pedidos
linenumberstrue
{
  "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType": "TABLE",
  "orderKey": ["40", "20"]
}
Nota
titleNota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.


...


3.5 - Request - Ao reenviar a solicitação, a resposta será a seguinte: Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código
titleJSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_40, 20"
		}
	]
}  
Nota
titleNota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.


...


3.6 - Request - Reenvio da solicitação, resposta de processamento: Reenviando a solicitação, o sistema processará o pedido e fornecerá a resposta com o status do processamento. 

Bloco de código
titleJSON de retorno de múltiplos pedidos
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "647469f8-b31b-4fae-ba33-99e04def555b",
	"orderKeyType": "TABLE",
	"orderKey": [
		"40",
		"20"
	],
	"lastestUpdatedStatus": "2024-06-28 09:13:46",
	"items": [
		,
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "4"
		},
		{
			"id": "3b35ffe5-b48d-4a66-b5bf-c6e2c5b82d8a",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "5"
		},
		{
			"id": "86ebfa7f-db95-42ad-baf0-b2a5e0865c74",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "6"
		},
		{
			"id": "64fe9584-8c9e-4587-8733-ae86ae9a8721",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "7"
		},
		{
			"id": "9dc5de7e-88f8-467f-bd85-bd3126db9160",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "8"
		},
		{
			"id": "60efbaa6-fbca-41ca-a03e-70986b1b6957",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "9"
		},
		{
			"id": "f6b6f8dc-e674-465e-b949-5d5851beb1b2",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "10"
		},
		{
			"id": "5ad276aa-27f1-41c4-8e66-136c052dcedf",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "11"
		},
		{
			"id": "693abccf-b584-4e40-83df-266e0d4a787e",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "12"
		},
		{
			"id": "2214be25-c48b-4917-b375-ebee2b5534d8",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "13"
		},
		{
			"id": "745f28a5-b6e0-43eb-9e86-32e6fe68174b",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "17"
		},
		{
			"id": "db5b9ae2-7111-4310-866b-5eb66a63bdbb",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "18"
		},
		{
			"id": "406a2a14-ac79-422a-b667-769fa1d2a9a0",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "19"
		},
		{
			"id": "3a18df72-bd49-4184-aeec-bc3d499bf4ba",
			"status": {
				"code": 506,
				"description": "CLOSED_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "20"
		},
		{
			"id": "2442a7dc8c3752a1-257dae15-4c0142a1-8b42bafb-55c9ada53420189ca95f0211",
			"status": {
				"code": 506505,
				"description": "CLOSEDTABLE_IN_TABLEUSE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "21"null,
		}
	]
}

...

Bloco de código
titleJSON Para retornar o status de um pedido específico
linenumberstrue
{
  "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType"cancellationReason": null,
			"tableCardNumber": "TABLE18"
		},
  "orderKey		{
			"id": ["40"]
}
Nota
titleNota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.

Bloco de código
titleJSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey""5ebf990f-9075-462c-b675-a8c57a350d61",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"messagetableCardNumber": "Order status request already exists: TABLE_4019"
		}
	]
}  
A solicitação já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.
Nota
titleNota: HTTP Status Code = 208 Already Reported
226 IM Used

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.


...


3.7 - Request - Retornar o status de múltiplos pedidos: Essa requisição é utilizada para obter o status atualizado de diversos pedidos simultaneamente. O sistema retornará as informações detalhadas de cada pedido.

Âncora
todos_status
todos_status

Bloco de código
titleJSON de resposta do retorno de um pedidoPara retornar o status de todos os pedidos
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "1853f0ab7056c970-faf7cb11-47d6400f-a1939d4f-610b208071439f30253f3b0b",
	  "orderKeyType": "TABLE",
	  "orderKey": [
		"40"
	],
	"lastestUpdatedStatus": "2024-06-28 09:04:06",
	"items": [
		{
			"id": "50425147-5d06-4b87-a05b-4586f2dccc71",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null]
}
Nota
titleNota: HTTP Status Code = 202 Accepted

A solicitação foi aceita, mas ainda não foi processada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.


...


3.8 - Request - Ao reenviar a solicitação, a resposta será a seguinte: Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código
titleJSON de resposta do retorno de um pedido específico HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"cancellationReasonmessage": null,
			"tableCardNumber": "40""Order status request already exists: TABLE_"
		}
	]
}  
Nota
titleNota: HTTP Status Code = 226 IM Used208 Already Reported

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.

...

já foi enviada. É necessário aguardar alguns momentos e, em seguida, entrar em contato no mesmo endereço para obter o status do pedido solicitado.


...


3.9 - Request - Ao reenviar a solicitação, a resposta será a seguinte: Ao reenviar a requisição, receberá uma resposta contendo o status atualizado e os detalhes dos pedidos.

Bloco de código
titleResposta do JSON da requisição

...

Bloco de código
titleJSON Para retornar múltiplos pedidos
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970ab3e5b94-cb113a02-400f423a-9d4f8500-9f30253f3b0bbbb5292fb13a",
  	"orderKeyType": "TABLE",
  "orderKey": ["40", "20"]
}
Bloco de código
titleJSON de retorno de múltiplos pedidos
linenumberstrue
{
	"successorderKey": true[],
	"errorlastestUpdatedStatus": null,
	"integrationHubServiceId "2024-09-24 17:35:52",
	"items": [
		{
			"id": "647469f8f217d261-b31b126c-4fae456a-ba33-99e04def555b",
	"orderKeyType86d5-d92eda8fbd1a",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"orderKeydeliveryAgent": [null,
			"40deliveryDateTime": null,
			"20cancellationReason": null,
	],
		"lastestUpdatedStatustableCardNumber": "2024-06-28 09:13:46",
	"items": [204"
		},
		{
			"id": "8c3752a11730ccab-ae15ba9e-42a14b0b-bafbb7f2-189ca95f0211ad2652659d0a",
			"status": {
				"code": 505504,
				"description": "TABLEOPEN_IN_USETABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "18500"
		},
		{
			"id": "5ebf990fdbd9bc55-90756c26-462c4160-b675bee3-a8c57a350d61e74822d8b81b",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "19503"
		}
	]
}
Nota
titleNota: HTTP Status Code = 226 IM Used

A solicitação foi processada com sucesso e o resultado foi retornado conforme esperado.


...


integrationHubServiceId: é um código da integração da loja com o Integration Hub

orderKey: é o código do pedido
Informações
titleNota:

Neste exemplo, os dados retornados incluem:

  • success: Indica se a operação foi bem-sucedida.

  • error: Contém informações sobre erros, se houver.

  • integrationHubServiceId: O identificador do serviço de integração.

  • orderKeyType: O tipo da chave do pedido (neste caso, "TABLE").

  • orderKey: A chave do pedido, que pode ser uma lista de identificadores.

  • lastestUpdatedStatus: A data e hora da última atualização do status do pedido.

  • items: Uma lista de itens relacionados ao pedido, onde cada item inclui:

    • id: O identificador do item.

    • status: O status atual do item, incluindo um código e uma descrição.

    • deliveryAgent: Informações sobre o agente de entrega, se aplicável.

    • deliveryDateTime: Data e hora de entrega, se aplicável.

    • cancellationReason: Motivo do cancelamento, se aplicável

      .
    • tableCardNumber: O número da mesa associada ao pedido.
Informações
titleInformação:

    • .

    • tableCardNumber: O número da mesa associada ao pedido.


Dicionário de Retorno


Informações sobre os retornos da API cancelledItems.

  • orderKeyType: Deve respeita a tabela abaixo:
EnumValor
TABLETABLE
CARDCARD
ORDERD_IDORDER_ID


  • orderKey: É o identificador do pedido:
CampoValor
orderKeyCódigo de identificação do pedido, sendo uma "string"


...

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:

...