TOTVS Food Service

Páginas filhas
  • API Order Cartão - Get Cancelled Items

Versões comparadas

Versão antiga 1

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

Chave

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

...

Bloco de código
titleCorpo da requisição no JSON
linenumberstrue
{
  "integrationHubServiceId": "7056c97005a7718d-cb1100ff-400f4c79-9d4fb726-9f30253f3b0b2ce19025850e",
  "orderKeyType": "TABLECARD",
  "orderKey": ["2240"]
}
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 - HTTP Status Code = 208
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType_orderKey",
			"message": "Order cancelled itens request already exists: TABLECARD_22,2340"
		}
	]
}
Nota
titleNota: HTTP Status Code = 208 Already Reported

A solicitação já foi enviada. É 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 - Status Code = 226
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c97005a7718d-cb1100ff-400f4c79-9d4fb726-9f30253f3b0b2ce19025850e",
	"orderKeyType": "TABLECARD",
	"orderKey": [
		"2240"
	],
	"lastestUpdatedStatus": "2024-0709-1710 14:2137:2414",
	"items": [
		{
			"id": "3973594571",
			"index": "5332018",
			"name": "MARACUJAALPES SUICOS ZERO",
			"externalCode": "5871",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-0709-1710 14:1936:3329",
			"cancellationReason": " 55596;",
			"tableCardNumber": "22340",
			"productionPoint": "NENHUM"
		}
	]
}

...

Bloco de código
titleCorpo da requisição no JSON
linenumberstrue
{
  "integrationHubServiceId": "7056c97005a7718d-cb1100ff-400f4c79-9d4fb726-9f30253f3b0b2ce19025850e",
  "orderKeyType": "TABLECARD",
  "orderKey": ["22", "23"]
}

...

Bloco de código
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c97005a7718d-cb1100ff-400f4c79-9d4fb726-9f30253f3b0b2ce19025850e",
	"orderKeyType": "TABLECARD",
	"orderKey": [
		"22",
		"23"
	],
	"lastestUpdatedStatus": "2024-07-17 16:18:40",
	"items": [
		{
			"id": "39735945",
			"index": "5",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-07-17 14:19:33",
			"cancellationReason": " 55596;",
			"tableCardNumber": "22",
			"productionPoint": "NENHUM"
		},
		{
			"id": "3973594011",
			"index": "19",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-07-17 16:04:27",
			"cancellationReason": " 55596;",
			"tableCardNumber": "23",
			"productionPoint": "NENHUM"
		}
	]
}

...

Bloco de código
titleJSON de retorno de múltiplos pedidos
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "d515293605a7718d-567800ff-44ef4c79-9d8eb726-e41462155a762ce19025850e",
	"orderKeyType": "TABLECARD",
	"orderKey": [
		"2",
		"5"
	],
	"lastestUpdatedStatus": "2024-08-16 09:28:06",
	"items": [
		{
			"id": "2",
			"index": "2",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-08-16 09:26:56",
			"cancellationReason": " 55596;",
			"tableCardNumber": "2",
			"productionPoint": "NENHUM"
		},
		{
			"id": "5",
			"index": "5",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-08-16 09:27:09",
			"cancellationReason": " 55596;",
			"tableCardNumber": "5",
			"productionPoint": "NENHUM"
		}
	]
}
Informaçõestip
titleNotaObservação:

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: Uma lista de identificadores de pedidos (neste caso, números de mesa).
  • lastestUpdatedStatus: A data e hora da última atualização do status dos pedidos.
  • items: Uma lista de itens cancelados, onde cada item inclui:
    • id: O identificador do item.
    • index: O índice do item.
    • name: O nome do item.
    • externalCode: O código externo do item.
    • quantity: A quantidade do item cancelado.
    • cancellationAgent: O agente que realizou o cancelamento.
    • cancellationDateTime: Data e hora do cancelamento.
    • cancellationReason: O motivo do cancelamento.
    • tableCardNumber: O número da mesa ou do cartão associado ao item cancelado.
    • productionPoint: O ponto de produção associado ao item.
Informações
titleInformação:

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

orderKey: é o código do pedido

Dica
titleObservação:

Para o correto funcionamento desse endpoint, o respectivo pedido deverá ter sido Para o correto funcionamento desse endpoint, o respectivo pedido deverá ter sido previamente cancelado no PDV para a API retornar a resposta do pedido cancelado


...

04. ERROS
Âncora
erros
erros

A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:

...

Bloco de código
titleJSON Inválido
linenumberstrue
{
    "integrationHubServiceId": "7056c97005a7718d-cb1100ff-400f4c79-9d4fb726-9f30253f3b0b2ce19025850e",
	  "orderKeyType": "string",
	   "orderKey": ["22"]
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}

...

Bloco de código
titleJSON Inválido
linenumberstrue
{
    "integrationHubServiceId": "a5c4e13505a7718d-aacd00ff-49c14c79-b051b726-160a78a83b562ce19025850e"
}
Bloco de código
titleJSON Resposta
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType is required"
		},
		{
			"key": "orderKey",
			"message": "body.orderKey is required"
		}
	]
}

...

Bloco de código
titleJSON com o GUID inválido
linenumberstrue
{
    "integrationHubServiceId": "9a1cf32605a7718d-c96200ff-456f4c79-8c49b726-c1bb2f340fc6A2ce19025850A",
	  "orderKeyType": "TABLECARD",
	  "orderKey": []
}
Bloco de código
titleJSON Inválido GUID incorreto
linenumberstrue
{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

...

Bloco de código
titleJSON com sem informar o código da orderKey
linenumberstrue
{
    "integrationHubServiceId": "808c143d05a7718d-d6d400ff-4b954c79-8c37b726-efa3a934f2222ce19025850e",
	  "orderKeyType": "TABLECARD",
	  "orderKey": [""]
}
Bloco de código
titleJSON Response
linenumberstrue
{
	"errors": [
		{
			"key": "orderKeyType",
			"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
		}
	]
}

...

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 integrationHubId  está incorreto ou inválido.

...

Bloco de código
titleIntegration Hub Code Inválido
linenumberstrue
{
    "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	  "orderKeyType": "TABLECARD",
	  "orderKey": ["5"]
}
Bloco de código
titleJSON Response
linenumberstrue
{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
		}
	]
}

...

Bloco de código
titleJSON da requisição
linenumberstrue
{
    "integrationHubServiceId": "7d7d205b05a7718d-83ba00ff-47c54c79-91bab726-e4f32a2bbd9e2ce19025850e",
	  "orderKeyType": "TABLECARD",
	  "orderKey": ["5"]
}
Bloco de código
titleResposta da última execução
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "5ffec6b8-1c55-4a7d-985f-12d13685b553",
	"orderKeyType": "TABLECARD",
	"orderKey": [
		"22"
	],
	"lastestUpdatedStatus": "2024-07-17 17:08:45",
	"items": [
		{
			"id": "39735945",
			"index": "5",
			"name": "MARACUJA",
			"externalCode": "58",
			"quantity": 1,
			"cancellationAgent": "ALBINO",
			"cancellationDateTime": "2024-07-17 14:19:33",
			"cancellationReason": " 55596;",
			"tableCardNumber": "22",
			"productionPoint": "NENHUM"
		}
	]
}
Nota
titleNota: HTTP Status Code = 429 - Too Many Requests

Alguma 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


API Order Mesa - New Order
API Order Mesa - Status
API Order Mesa Cartão - Get Consumption
API Order Mesa Cartão- Consumption
API Order Mesa Cartão - PaymentAPI Order Mesa - Payment Result
API Order Mesa - Get Status
API Order Mesa - Cancelled Items



Templatedocumentos