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
  • 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.

...

Bloco de código
titleJSON Para pedido inexistente
{
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"orderKeyType": "TABLE",
	"orderKey": ["99999"]
}
Bloco de código
titleRetorno do JSON - HTTP Status Code = 208
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_999999"
		}
	]
}
Bloco de código
titleJSON Para pedido inexistente
{
    "success": true,
    "error": null,
    "integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
    "orderKeyType": "TABLE",
    "orderKey": [
        "40"
    ],
    "lastestUpdatedStatus": "2024-06-28 09:54:27",
    "items": [
        {
            "id": "40",
            "status": {
                "code": 412,
                "description": "NOT_FOUND"
            },
            "deliveryAgent": null,
            "deliveryDateTime": null,
            "cancellationReason": null,
            "tableCardNumber": null
        }
    ]
}





Bloco de código
{
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"orderKeyType": "TABLE",
	"orderKey": "AA"
}



Bloco de código
{
	"errors": [
		{
			"key": "orderKey",
			"message": "body.orderKey must be an array"
		}
	]
}


 


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




Bloco de código

...

{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order status request already exists: TABLE_AA"
		}
	]
}



...





...