Páginas filhas
  • API Order Mesa - Get Status

Versões comparadas

Chave

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

...

  • Visão Geral
  • Endpoint
  • Exemplo de Utilização
  • Erros
  • Links

01. VISÃO GERAL

Esse endpoint serve para retorar os status dos pedidos

Este endpoint é utilizado para obter informações detalhadas sobre os pedidos, fornecendo um retorno em formato JSON com diversos atributos relevantes. Ao enviar um pedido no formato especificado, como nos exemplos abaixo. O endpoint processa a solicitaçã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.

...

Bad Request — Solicitação Inválida

01. Formando inválido do JSON esperado.

...

Bloco de código
titleJSON Resposta
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}


02. JSON enviando faltando um ou mais campos.

...

Bloco de código
titleJSON Resposta
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType is required"
		},
		{
			"key": "orderKey",
			"message": "body.orderKey is required"
		}
	]
}


03. GUID incorreto 


Bloco de código
titleJSON Inválido GUID incorreto
{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

...

Nota
titleNota: 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.


...


02. Unauthorized — Não autorizado 


Nota
titleNota: 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.

...