Páginas filhas
  • API Order Mesa - Get Status

Versões comparadas

Chave

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

...

Bloco de código
titleJSON Para retornar um pedido específico
{
  "integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
  "orderKeyType": "TABLE",
  "orderKey": ["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
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_40"
		}
	]
}  
 
Nota
titleNota: HTTP Status Code = 202 Accepted208 Already Reported


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

...

Informações
titleInformaçã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.


Bad Request — Solicitação Inválida

01. Formando inválido do JSON esperado.




Bloco de código
titleJSON Inválido
{
    "integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	  "orderKeyType": "string",
		"orderKey": ["string"]
}
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 Inválido
{
    "integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553"
}
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.





...


Bloco de código
titleJSON Para pedido inexistente
{
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"orderKeyType": "TABLE",
	"orderKey": ["99999"]
}

...