TOTVS Food Service

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

Versões comparadas

Versão antiga 2

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

Gravado em

comparado com

Nova versão 3

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

Gravado em

Chave

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

CONTEÚDO

...

02. ENDPOINT
Âncora
endpoint
endpoint


MétodoURL
POSThttps://api-barramento.meuelevestage.com/order/getStatus


...

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

01. Retornar todos os estados dos pedidos: 

Âncora
todos_status
todos_status

...

Bloco de código
titleJSON de resposta do retorno de um pedido
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": [
		"40"
	],
	"lastestUpdatedStatus": "2024-06-28 09:04:06",
	"items": [
		{
			"id": "50425147-5d06-4b87-a05b-4586f2dccc71",
			"status": {
				"code": 505,
				"description": "TABLE_IN_USE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "40"
		}
	]
}

...

Bloco de código
titleJSON de retorno de múltiplos pedidos
linenumberstrue
{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
	"orderKeyType": "CARD",
	"orderKey": [
		"40",
		"20"
	],
	"lastestUpdatedStatus": "2024-09-12 11:56:09",
	"items": [
		{
			"id": "2160c838-97d0-432f-a43a-dce087150d49",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "340"
		},
		{
			"id": "360",
			"status": {
				"code": 412,
				"description": "NOT_FOUND"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": null
		}
	]
}


...

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 403, conhecido como "Forbidden" (Proibido), indica que o servidor não entendeu a requisição do cliente por está tentando acessar uma URL incorreta.

Bloco de código
titleURL enviada incorreda
https://api-barramento.meuelevestage.com/order/getStatuS

...

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.

...


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



Templatedocumentos