Histórico da Página

...

02. ENDPOINT
Âncora
endpoint
endpoint

Método	URL	Ambiente
POST	https://api-barramento.meuelevestage.com/order/cancelledItens	Homologação
POST	https://api-barramento.meueleve.com/order/cancelledItens	Produção

...

03. EXEMPLO DE UTILIZAÇÃO
Âncora
utilizar
utilizar

01. Corpo 3.1 - Envio da requisição para obter o status de um cancelamento especificoitem cancelado no PDV:
Ao enviar a requisição para este endpoint, o sistema processa a solicitação e retorna o status atualizado de um item cancelado no PDV. O corpo da requisição deve conter os dados obtidos no endpoint getCancelledItems, e a resposta fornecerá as informações detalhadas sobre o cancelamento solicitado.:

Âncora

	todos_status
	todos_status

...

Nota

title	Nota: HTTP Status Code = 226 IM Used

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

...

023.2. Request - Corpo da requisição de para consultar o cancelamento de vários pedidos no PDV específico:

Essa requisição é enviada para verificar se os itens de vários pedidos cancelados em um PDV específico foram transmitidos com sucesso.

múltiplos cancelamentos:

Âncora

	multiplos
	multiplos

Bloco de código

title	Corpo da requisição no JSON
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "011c8369-51c1-4d49-9dab-9d4ed9f38844",
	"orderKeyType": "CARD",
	"orderKey": [
		"22",
		"23"
	],
	"lastestUpdatedStatus": "2024-07-18 09:48:03",
	"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"
		}
	]
}

Dica

title	Dica

O corpo da requisição enviada é o mesmo que o corpo da resposta obtida através do endpoint GetCancelledItems

Dicionário de Request

Informações sobre o campos da request da API cancelledItems, é utilizada para retornar os dados do(s) pedido(s) cancelado(s).

Estrutura cancelledItems:

Campo	Valor	Descrição
success *	boolean	Indica se a operação foi bem-sucedida
error	objeto	Contém informações sobre erros, se houver (veja na tabela de error)
integrationHubServiceId *	string	Chave de identificação de integração
orderKeyType *	enum	Tipo da chave do pedido (veja na tabela orderKeyType)
orderKey *	array	Lista de identificadores de pedidos (números de mesa, cartão, ou ID de pedido)
lastestUpdatedStatus *	string (data e hora)	Data e hora da última atualização do status dos pedidos
items *	array	Lista de itens cancelados

Enumerações para orderKeyType:
Âncora
table_orderKeyType
table_orderKeyType

Enum	Valor	Descrição
TABLE	TABLE	Identifica o pedido pelo número da mesa
CARD	CARD	Identifica o pedido pelo número do cartão
ORDER_ID	ORDER_ID	Identifica o pedido por um ID exclusivo

Estrutura cancelledItems (dentro de item):

Campo	Valor	Descrição
id *	string	Identificador do produto no lançamento.
index *	string	Posição do produto no lançamento.
name *	string	Nome do item/produto.
externalCode *	string	Código do produto no PDV integrado.
quantity *	número	Quantidade do item cancelado.
cancellationAgent *	string	Operador responsável pelo cancelamento.
cancellationDateTime *	string (data e hora)	Data e hora do cancelamento.
cancellationReason *	string	Motivo do cancelamento.
tableCardNumber *	string	Número da mesa ou cartão associado ao item cancelado
productionPoint *	string	Ponto de produção relacionado ao item

Estrutura Error:
Âncora
table_error
table_error

Enum	Valor	Descrição
code *	código do erro	Identifica o código do erro
message *	messagem do erro	Descrição detalhada do erro ocorrido, ex: "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"

Dica

title	Campos obrigatórios

Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório

...

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:

...

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.

4.1 - Formato inválido do JSON esperado:

A requisição foi enviada com um JSON malformado ou inválido, o que impede o sistema de interpretá-la corretamente. Isso ocorre quando a estrutura JSON contém erros de sintaxe, como chaves ou colchetes incorretos01. JSON enviando faltando um ou mais campos.

Bloco de código

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

{
	"integrationHubServiceId": "011c8369-51c1-4d49-9dab-9d4ed9f38844",
	"orderKeyType": "CARD",
	"orderKey": [
		"22",
		"23"
	],
	"lastestUpdatedStatus": "2024-07-18 09:48:03",
	"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

title	Resposta do JSON da requisição
linenumbers	true

{
	"errors": [
		{
			"key": "success",
			"message": "body.success is required"
		}
	]
}

...

4.2 - JSON enviado com a ausência de um ou mais campos obrigatórios:

Se a requisição estiver faltando um ou mais campos obrigatórios, o servidor responderá com um erro 400. Cada campo requerido deve estar presente para que a operação seja processada corretamente02. Formando inválido do JSON esperado

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "011c8369-51c1-4d49-9dab-9d4ed9f38844",
	"orderKeyType": "String",
	"orderKey": [
		"22",
		"23"
	],
	"lastestUpdatedStatus": "2024-07-18 09:48:03",
	"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"
		}
	]
}

...

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 StatusAPI Order Mesa - Get Status

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

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
utilizar
utilizar

04. ERROS
Âncora
erros
erros

05. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

02. ENDPOINT Âncoraendpointendpoint

03. EXEMPLO DE UTILIZAÇÃO Âncorautilizarutilizar

04. ERROS Âncoraerroserros

05. LINKS Âncoralinkslinks

02. ENDPOINT
Âncora
endpoint
endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
utilizar
utilizar

04. ERROS
Âncora
erros
erros

05. LINKS
Âncora
links
links