Histórico da Página

...

O endpoint Get Status da API Order Mesa é utilizado no ponto de venda (PDV) para obter o envio do resultado da solicitação de status dos pedidos do Ponto de Venda (PDV). Este endpoint recebe o mesmo corpo de requisição utilizado pelo endpoint GetOrderStatus - API Order Mesa - Get Status

...

Bloco de código

title	Corpo da requisição no JSON
linenumbers	true

{
	"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": "d19436e4-99da-4593-a92a-46125f076e12",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "3"
		},
		{
			"id": "05bc9478-60cc-43b3-87bb-6f9a1d0cf295",
			"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": "2442a7dc-257d-4c01-8b42-55c9ada53420",
			"status": {
				"code": 506,
				"description": "CLOSED_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "21"
		}
	]
}

Dica

title	Dica

O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint GetOrderStatus.

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

04. Retornar 03. Corpo da requisição para obter o status de múltiplos pedidos:

Âncora

	multiplos
	multiplos

Bloco de código

title	JSON Para retornar múltiplos pedidosCorpo da requisição no JSON
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970647469f8-cb11b31b-400f4fae-9d4fba33-9f30253f3b0b99e04def555b",
  	"orderKeyType": "TABLE",
  	"orderKey": [
		"4018", 
		"2019"
	]
}

Bloco de código

title	JSON de retorno de múltiplos pedidos
linenumbers	true

{
	"success": true,
	"lastestUpdatedStatus": "2024-06-28 09:13:46",
	"erroritems": null,[
		{
			"integrationHubServiceIdid": "647469f88c3752a1-b31bae15-4fae42a1-ba33bafb-99e04def555b189ca95f0211",
			"orderKeyTypestatus": "TABLE",{
				"orderKeycode": [505,
		"18",
		"19"
	],
	"lastestUpdatedStatus": "2024-06-28 09:13:46",
	"items": [
		{description": "TABLE_IN_USE"
			},
			"iddeliveryAgent": "8c3752a1-ae15-42a1-bafb-189ca95f0211"null,
			"statusdeliveryDateTime": {null,
				"codecancellationReason": 505null,
				"descriptiontableCardNumber": "TABLE_IN_USE18"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "18"
		},
		{
			"id": "5ebf990f-9075-462c-b675-a8c57a350d61",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "19"
		}
	]
}

Informaçõestip

title	Nota:	Dica

O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint GetOrderStatus.

Informações

title	Nota:

Neste exemplo, os dados 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.

...

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 JSON enviando faltando um ou mais campos.

Bloco de código

title	JSON InválidoCorpo da requisição no JSON faltando campos
linenumbers	true

{
    	"integrationHubServiceId": "393d95725ffec6b8-2ec91c55-4cda4a7d-9ad3985f-5b69e02c988d12d13685b5538",
	  "orderKeyTypesuccess": "string"true,
	   "orderKeyorderStatus": ["string"]
}

Bloco de código

title	JSON Resposta
linenumbers	true


		{
			"errorsid": ["bd768726-91ef-4161-b35b-4e28e711dfd8",
			"status": {
				"keycode": "orderKeyType"1,
				"messagedescription": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"Em Preparo"
			}
		}
	]
}

...

Bloco de código

title	Resposta do JSON Inválidoda requisição
linenumbers	true

{
    "integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "orderKeyTypeintegrationHubServiceId",
			"message": "body.orderKeyTypeintegrationHubServiceId is must be a valid GUID"
		},
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType is required"
		},
		{
			"key": "orderKey",
			"message": "body.orderKey is required"
		}
	]
}

03. GUID incorreto 02. Formando inválido do JSON esperado

Bloco de código

title	JSON com o GUID inválidoInválido
linenumbers	true

{
    "integrationHubServiceId	"success": "9a1cf326-c962-456f-8c49-c1bb2f340fc6Atrue,
	"error": null,
	"integrationHubServiceId": "644a4d3c-6d2c-4154-a089-c1ab3fd89151",
	  "orderKeyType": "TABLEString",
	  "orderKey": []
}

Bloco de código

title	JSON Inválido GUID incorreto
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

04. Enviando uma requisição sem informar o código da orderKey corretamente

Bloco de código

title	JSON com sem informar o código da orderKey
linenumbers	true

{
    "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
	  "orderKeyType": "TABLE",
	  "orderKey": [""
		"22"
	],
	"lastestUpdatedStatus": "2024-07-16 15:48:30",
	"items": [
		{
			"id": "975dbf9b-a11d-4efe-b491-197ee123bfe4",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "22"
		}
	]
}

Bloco de código

title	Resposta do JSON Response da requisição
linenumbers	true

{
	"errors": [
		{
			"key": 0"orderKeyType",
			"message": "body.orderKey[0] is not allowed to be emptyorderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}

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 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 , mas está se recusando a cumpri-la. Isso geralmente ocorre quando o cliente não possui permissões adequadas para acessar o recurso solicitado, mesmo que as credenciais de autenticação tenham sido fornecidas corretamente.por está tentando acessar uma URL incorreta

Bloco de código

title	URL enviada incorreda

https://api-barramento.meuelevestage.com/order/getStatuSstatusS

Bloco de código

title	JSON Response para URL incorreta Corpo da requisição no JSON
linenumbers	true

{
	"message    "integrationHubServiceId": "Missing Authentication Token"
1188f64e-3ce8-45be-882c-6c8dcfcb70d4",
	  "orderKeyType": "TABLE",
	   "orderKey": ["09"]
}

Nota

title	Nota: HTTP Status Code = 403 - Forbidden

O cliente não incluiu um token de autenticação válido no cabeçalho da requisiçãoenviou 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 URL fornecido está incorreto, o recurso foi removido permanentemente ou não está disponível no momento da requisição.

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true

{
    "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	  "orderKeyType": "TABLE",
		"orderKey": ["5"]
}

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

Nota

title	Nota: HTTP Status Code = 404 - Not Found

Uma ou mais informações enviadas não puderam ser encontradas.

...

token da requisição da autenticação, é diferente do token gerado utilizando o integrationHubId diferente do corpo da requisição.

Bloco de código

title	JSON de retorno de múltiplos pedidos

...

O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição.

Bloco de código

title	JSON
linenumbers	true

{
    "integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

Bloco de código

title	HTTP Status Code 412 = Precpndition Failed
linenumbers	true

{
	"message": "NOT_FOUND",
	"code": 412
}

Nota

title	Nota: HTTP Status Code = 412 Precondition Failed

Alguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos.

...

O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.

Bloco de código

title	JSON da requisição
linenumbers	true

{
    "integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
	  "orderKeyType": "TABLE",
		"orderKey": ["5"]
}

Bloco de código

title	Resposta da última execução
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7d7d205bf1b874af-83ba96ab-47c54535-91baaac3-e4f32a2bbd9e25118fe586cc",
	"orderKeyType": "TABLE",
	"orderKey": [
		"519"
	],
	"lastestUpdatedStatus": "2024-07-0215 1817:5402:2835",
	"items": [
		{
			"id": "de9fd388406a2a14-c223ac79-4325422a-a64db667-08889250f839769fa1d2a9a0",
			"status": {
				"code": 504505,
				"description": "OPENTABLE_IN_TABLEUSE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"deliveryDateTime": null,,
			"tableCardNumber": "19"
		}
	]
}

Bloco de código

title	Resposta do JSON da requisição
linenumbers	true

{
	"errors": [
		{
			"cancellationReasonkey": null"orderKeyType_orderKey",
			"tableCardNumbermessage": "5Order status for: TABLE_22 not found"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 429 - Too Many Requests404 - Not Found

Uma ou mais informações enviadas não puderam ser encontradasAlguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões.

...

05. LINKS
Âncora
links
links

...

Páginas filhas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

05. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

05. LINKS Âncoralinkslinks

05. LINKS
Âncora
links
links