Histórico da Página

CONTEÚDO

01. VISÃO GERAL

...

Âncora
ver_geral
ver_geral

O endpoint Get Status da API Order Mesa é utilizado para 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

...

02. ENDPOINT
Âncora
endpoint
endpoint

Método	URL
POST	https://api-barramento.meuelevestage.com/order/status

...

03. EXEMPLO DE UTILIZAÇÃO

01. O corpo da requisição enviada para retornar todos os status dos pedidos é o seguinte:

Âncora

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

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

02. Enviando o pedido para obter o status de um pedido especifico:

Âncora

	detalhes_pedido_especifico
	detalhes_pedido_especifico

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": [
		"19"
	],
	"lastestUpdatedStatus": "2024-07-15 16:40:13",
	"items": [
		{
			"id": "406a2a14-ac79-422a-b667-769fa1d2a9a0",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "19"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

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

Âncora

	multiplos
	multiplos

Bloco de código

title	Corpo da requisição no JSON
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "647469f8-b31b-4fae-ba33-99e04def555b",
	"orderKeyType": "TABLE",
	"orderKey": [
		"18",
		"19"
	],
	"lastestUpdatedStatus": "2024-06-28 09:13:46",
	"items": [
		{
			"id": "8c3752a1-ae15-42a1-bafb-189ca95f0211",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"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"
		}
	]
}

Dica

title	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 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

title	Informação:

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

orderKey: é o código do pedido

...

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

Bloco de código

title	Corpo da requisição no JSON faltando campos
linenumbers	true

{
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b5538",
	"success": true,
	"orderStatus": [
		{
			"id": "bd768726-91ef-4161-b35b-4e28e711dfd8",
			"status": {
				"code": 1,
				"description": "Em Preparo"
			}
		}
	]
}

Bloco de código

title	Resposta do JSON da requisição
linenumbers	true

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

02. Formando inválido do JSON esperado

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "644a4d3c-6d2c-4154-a089-c1ab3fd89151",
	"orderKeyType": "String",
	"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 da requisição
linenumbers	true

{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType 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 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/statusS

Bloco de código

title	Corpo da requisição no JSON
linenumbers	true

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

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 ocorrer quando o 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
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	"orderKeyType": "TABLE",
	"orderKey": [
		"19"
	],
	"lastestUpdatedStatus": "2024-07-15 17:02:35",
	"items": [
		{
			"id": "406a2a14-ac79-422a-b667-769fa1d2a9a0",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "19"
		}
	]
}

Bloco de código

title	Resposta do JSON da requisição
linenumbers	true

{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status for: TABLE_22 not found"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 404 - Not Found

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

...

05. LINKS
Âncora
links
links

API Order Mesa - Get Status
API Order Mesa - Get Consumption
API Order Mesa - Consumption
API Order Mesa - Payment
API Order Mesa - Payment Result
API Order Mesa - Get Cancelled Items
API Order Mesa - Cancelled Items

Esse endpoint serve para informar os status dos pedidos

...

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

01. VISÃO GERAL

Âncora
ver_geral
ver_geral

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO

04. ERROS

05. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

01. VISÃO GERAL

Âncoraver_geralver_geral

02. ENDPOINT Âncoraendpointendpoint

03. EXEMPLO DE UTILIZAÇÃO

04. ERROS

05. LINKS Âncoralinkslinks

Âncora
ver_geral
ver_geral

02. ENDPOINT
Âncora
endpoint
endpoint

05. LINKS
Âncora
links
links