Histórico da Página

CONTEÚDO

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

Este endpoint é utilizado Essa documentação tem como finalidade demonstrar o formato do JSON para envio de requisição para novos pedidos na API Order mesa via barramentrequisições de pedidos, como valor integração e adicionais.

...

02.

...

EXEMPLO DE UTILIZAÇÃO
Âncora

...

utilizar

...

utilizar

2.1 - Request Itens com Valor Integral e Adicionais:

Estrutura do corpo da requisição para criação de novos pedidos com itens de valor integral e adiconais

Bloco de código

title	JSON para pedido com inteiro

03. EXEMPLO DE UTILIZAÇÃO

...

Bloco de código

title	JSON para pedido com inteiro
linenumbers	true

{
   	"integrationHubServiceId": "933aadb43fea8768-c33bbbd9-40b8454b-82859e7b-bf1e575d8b3840841e9a6812",
   	"data": {
      		"id": "9ec389e5f4114e16-7582c2e4-47684dc3-875b86f3-ee7c309aa34f98a52bfd5d7d",
      		"type": "TABLE",
      		"displayId": "2958",
      		"createdAt": "2024-06-24T17:35:00",
      		"orderTiming": "2024-06-24T17:40:24",
      		"preparationStartDateTime": "2024-06-24T18:00:00",
      		"merchant": {
         			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
         			"name": "BOTECO DO ALBINO"
      		},
      		"items": [
         {
            
			{
				"id": "397359402161",
            				"index": "2160",
            				"name": "MARACUJAA FRANCESA",
            				"externalCode": "581",
            				"unit": "UN",
            				"quantity": 1.0,
            ,
				"specialInstructions": "Teste",
            				"unitPrice":{
                {
					"value":61 69.00,
               90,
					"currency": "R$"
            },
            				},
				"optionsPrice": {
               "value":0.0,
               					"value": 0.0,
					"currency": "R$"
            },
            				},
				"totalPrice": {
        					"value": 69.90,
					"currency": "R$"
				},
				 "options": [
       "value":61.00,
   {
            "currencyindex": "R$61",
            } "id": "61",
            "otherFeesname":[]
 "COMPOSICAO A",
       }
      ]"externalCode": "201",
      "total":{
      "unit":   "itemsUN":61.00,
            "otherFeesquantity":0 1,
            "discountunitPrice":0.00,
 {
              "orderAmountvalue":61 1.00,
              "additionalFeescurrency":0,
 "R$"
            "deliveryFee":0},
      },
      "paymentsoriginalPrice": {
              "prepaidvalue":0 1.000,
              "pendingcurrency":0.0,
 "R$"
           "methods":[ },
            "totalPrice": {
               "value":61 1.00,
               "currency": "BRLR$",
               "type":"PREPAID"},
               "methodproductionPoint": "creditTeste",
          }
       "methodInfo":"Visa",
               "changeFor":0.0
            }
         ]
      },
      "delivery":null,
      "extraInfo":"Teste",
      "schedule":null,
      "indoor":null,
      "takeout":null,
      "table":{
         "waiterCode":"9999",
         "tableNumber":"29",
         "chairNumber":"1"
      },
      "card":null
   }
}

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

Bloco de código

title	JSON da requisição do vários itens no pedido
linenumbers	true

{
	"integrationHubServiceId": "ff932717-fab5-4636-a294-a2035f774445",
	"data ]
			}
		],
		"otherFees": [],
		"total": {
			"items": 70.90,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 70.90,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 70.90,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"idwaiterCode": "c5f0f7d9-88fa-471d-904d-d8920ac866e79999",
			"typetableNumber": "TABLE57",
			"displayIdchairNumber": "41"
		},
		"createdAtcard": null
	}
}

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

03. ERROS
Âncora
erros
erros

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

HTTP Status Code - 400 - Bad Request
Âncora
status_code_400
status_code_400

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.

3.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 incorretos

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "b1e26dd8-0a1b-486e-bf62-65e80ddce2f4",
		"type": "TABLE",
		"displayId": 55,
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "54",
				"index": "54",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste"2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "5",
				"index": "5",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			},
			{
				"id": "6",
				"indexunitPrice": "6",{
					"namevalue": "BRIGADEIRO TRADICIONAL CX"61.00,
					"externalCodecurrency": "7"R$"
				},
				"unitoptionsPrice": "UN",{
					"quantityvalue": 10.0,
					"specialInstructionscurrency": "Teste"R$"
				},
				"unitPricetotalPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"optionsPricetotal": {
					"valueitems": 061.0,
					"currencyotherFees": "R$"0,
				}"discount": 0.0,
				"totalPriceorderAmount": {
		61.0,
			"valueadditionalFees": 61.000,
					"currencydeliveryFee": "R$"0
				}
			}
		],
		"otherFeespayments": [],{
			"totalprepaid": {0.0,
			"itemspending": 610.0,
			"otherFeesmethods": 0,[
			"discount": 0.0,
	{
					"orderAmountvalue": 61.0,
					"additionalFeescurrency": 0"BRL",
					"deliveryFeetype": 0"PREPAID",
			},
		"paymentsmethod": {"credit",
					"prepaidmethodInfo": 0.0"Visa",
					"pendingchangeFor": 0.0,
			"methods": [	}
				{]
			},
		"valuedelivery": 61.0null,
					"currencyextraInfo": "BRLTeste",
		"schedule": null,
			"typeindoor": null,
		"PREPAIDtakeout": null,
		"table": {
			"methodwaiterCode": "credit9999",
					"methodInfotableNumber": "Visa54",
					"changeForchairNumber": 0.0"1"
				}
			]
		},
		"deliverycard": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": }
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"waiterCodekey": "9999displayId",
			"tableNumbermessage": "4",
			"chairNumber": "1"body.data.displayId must be a string"
		},
		"card": null
	}
}

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

]
}

...

3.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 corretamente.

Bloco de código

title	JSON Inválido

...

Bloco de código

title	JSON para pedido com item fracionado
linenumbers	true

{
   	"integrationHubServiceId": "a13ea12d3fea8768-1ffcbbd9-4f4c454b-a3e89e7b-a384fe0e9e0540841e9a6812",
   	"data": {
      "		"id": "f853a079fa3a2d45-d0cb3a29-46124136-847f95e7-430460485c02692d93db8b2b",
      		"type": "TABLE",
      		"displayId": "2955",
      		"createdAt": "2024-06-24T17:35:00",
      		"orderTiming": "2024-06-24T17:40:24",
      		"preparationStartDateTime": "2024-06-24T18:00:00",
      "merchant":{
         		
		"items": [
			{
				"id":"3d0cbd44-a6c4-469c-8ab3-c83700672ee1 "54",
         				"index": "54",
				"name": "BOTECO DO ALBINO"
      },
      "items":[
         {
            "id":"3973594022",
            "index":"22",
            "name":"MARACUJA",
            "externalCode":"58",
            "unit":"UN",
            "quantity":0.5,
            "specialInstructions":"Teste",
            "unitPrice":{
               "value":61.00,
               "currency":"R$"
            },
            "optionsPrice":{
               "value":0.0,
               "currency":"R$"
            },
            "totalPrice":{
               "value":30.50,
               "currency":"R$"
            },
            "otherFees":[]
         }
      ],
      "total":{
         "items":30.50,
         "otherFees":0,
         "discount":0.00,
         "orderAmount":20.50,
         "additionalFees":0,
         "deliveryFee":0
      },
      "payments":{
         "prepaid":0.0,
         "pending":0.0,
         "methods":[
            {
               "value":30.50,
               "currency":"BRL",
               "type":"PREPAID",
               "method":"credit",
               "methodInfo":"Visa",
               "changeFor":0.0
            }
         ]
      },
      "delivery":null,
      "extraInfo":"Teste",
      "schedule":null,
      "indoor":null,
      "takeout":null,
      "table":{
         "waiterCode":"9999",
         "tableNumber":"29",
         "chairNumber":"1"
      },
      "card":null
   }MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"total": {
			"items": 61.0,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 61.0,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 61.0,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "9999",
			"tableNumber": "54",
			"chairNumber": "1"
		},
		"card": null
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

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

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

Bloco de código

title	JSON pedidos com desconto
linenumbers	true

{
  "integrationHubServiceId":"4c9952fd-90d6-46f1-afd2-381c21e73cfc",
  "data":{
     "id":"4c9952fd-90d6-46f1-afd2-381c21e73cfc",
     "type":"TABLE",
     "displayId":"9",
     "createdAt":"2024-06-24T17:35:00",
     "orderTiming":"2024-06-24T17:40:24",
     "preparationStartDateTime":"2024-06-24T18:00:00",
     "merchant":{
        "id":"c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
        "name":"BOTECO DO ALBINO"
     },
     "items":[
        {
           "id":"9",
           "index":"9",
           "name":"MARACUJA",
           "externalCode":"58",
           "unit":"UN",
           "quantity":1.0,
           "specialInstructions":"Teste",
           "unitPrice":{
              "value":61.00,
              "currency":"R$"
           },
           "optionsPrice":{
              "value":0.0,
              "currency":"R$"
           },
           "totalPrice":{
              "value":61.00,
              "currency":"R$"
           }
        }
     ],
     "otherFees":[],
     "discounts":[
        {
           "value":10.0,
           "target":"ITEM",
           "targetId":"9",
           "sponsorshipValues":[
              {
                 "name":"MARKETPLACE",
                 "value":0.0
              }
           ]
        }
     ],
     "total":{
        "items":61.00,
        "otherFees":0,
        "discount":10.0,
        "orderAmount":51.00,
        "additionalFees":0,
        "deliveryFee":0
     },
     "payments":{
        "prepaid":0.0,
        "pending":0.0,
        "methods":[
           {
              "value":51.00,
              "currency":"BRL",
              "type":"PREPAID",
              "method":"credit",
              "methodInfo":"Visa",
              "changeFor":0.0
           }
        ]
     },
     "delivery":null,
     "extraInfo":"Teste",
     "schedule":null,
     "indoor":null,
     "takeout":null,
     "table":{
        "waiterCode":"9999",
        "tableNumber":"9",
        "chairNumber":"1"
     },
     "card":null
  }
}

...

Bloco de código

title	JSON pedidos com item fracionando
linenumbers	true

{
	"integrationHubServiceId": "72ec722e-b643-4076-b1cd-ef388901ba66",
	"data": {
		"id": "57e20fc5-bea5-4372-9bfc-126e1961d99b",
		"type": "TABLE",
		"displayId": "9",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "10",
				"index": "10",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 30.50,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"discounts": [
			{
				"value": 10.0,
				"target": "ITEM",
				"targetId": "10",
				"sponsorshipValues": [
					{
						"name": "MARKETPLACE",
						"value": 0.0
					}
				]
			}
		],
		"total": {
			"items": 30.50,
			"otherFees": 0,
			"discount": 10.0,
			"orderAmount": 20.50,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 20.50,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "9999",
			"tableNumber": "10",
			"chairNumber": "1"
		},
		"card": null
	}
}

Bloco de código

title	Nota: HTTP Status Code = 200 OK
linenumbers	true

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

Informações

title	Nota:

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: A chave do pedido, que pode ser uma lista de identificadores.
lastestUpdatedStatus: A data e hora da última atualização do status do pedido.
items: Uma lista de itens relacionados ao pedido, onde cada item inclui:
- id: O identificador do item.
- status: O status atual do item, incluindo um código e uma descrição.
- deliveryAgent: Informações sobre o agente de entrega, se aplicável.
- deliveryDateTime: Data e hora de entrega, se aplicável.
- cancellationReason: Motivo do cancelamento, se aplicável.
- tableCardNumber: O número da mesa associada ao pedido.

Informações

title	Informaçã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 ao lidar com requisições HTTP e suas respectivas respostas:

...

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.

...

HTTP Status Code 401 - Unauthorized
Âncora
status_code_401
status_code_401

O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

Nota

title	Nota: 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.

...

HTTP Status Code 403 - Forbidden
Âncora
status_code_403
status_code_403

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

title	URL enviada incorreda

https://api-barramento.meuelevestage.com/order/newOrderS

Bloco de código

title	JSON Response para URL incorreta
linenumbers	true

{
	"message": "Missing Authentication Token"
}

Nota

title	Nota: HTTP Status Code = 403 - Forbidden

O cliente não enviou uma requisição para a URL incorreta.

...

HTTP Status Code 404 - Not Found
Âncora
status_code_404
status_code_404

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

title	Integration Hub Code Inválido
linenumbers	true

{
	"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	"data": {
		"id": "f1bddb3f-63c4-4b2f-be53-e4527275ad9d",
		"type": "TABLE",
		"displayId": "55",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "54",
				"index": "54",
				"name": "MARACUJA",
				"externalCode": "58",
				"unit": "UN",
				"quantity": 1.0,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 61.00,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 0.0,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 61.00,
					"currency": "R$"
				}
			}
		],
		"otherFees": [],
		"total": {
			"items": 61.0,
			"otherFees": 0,
			"discount": 0.0,
			"orderAmount": 61.0,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {
			"prepaid": 0.0,
			"pending": 0.0,
			"methods": [
				{
					"value": 61.0,
					"currency": "BRL",
					"type": "PREPAID",
					"method": "credit",
					"methodInfo": "Visa",
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "9999",
			"tableNumber": "54",
			"chairNumber": "1"
		},
		"card": null
	}
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"

...

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.

01. Formando inválido do JSON esperado.

Bloco de código

title	JSON Inválido
linenumbers	true

{
    "integrationHubServiceId": "393d9572-2ec9-4cda-9ad3-5b69e02c988d",
	  "orderKeyType": "string",
	   "orderKey": ["string"]
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"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

title	JSON Inválido
linenumbers	true

{
    "integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
}

Bloco de código

title	JSON Resposta
linenumbers	true

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

03. GUID incorreto

Bloco de código

title	JSON com o GUID inválido
linenumbers	true

{
    "integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

Bloco de código

title	JSON Inválido GUID incorreto
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "body.integrationHubServiceId must be a valid GUID"
		}
	]
}

04. Enviando uma requisição sem informar o código da orderKey corretamente

Bloco de código

title	JSON com sem informar o código da orderKey
linenumbers	true

{
    "integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
	  "orderKeyType": "TABLE",
	  "orderKey": [""]
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": 0,
			"message": "body.orderKey[0] is not allowed to be empty"
		}
	]
}

Nota

title	Nota: 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.

...

O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.

Nota

title	Nota: 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.

...

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

title	URL enviada incorreda

https://api-barramento.meuelevestage.com/order/getStatuS

Bloco de código

title	JSON Response para URL incorreta
linenumbers	true

{
	"message": "Missing Authentication Token"
}

Nota

title	Nota: HTTP Status Code = 403 - Forbidden

O cliente não enviou uma requisição para a URL incorreta.

...

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

title	Integration Hub Code Inválido
linenumbers	true

{
    "integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	  "orderKeyType": "TABLE",
	  "orderKey": ["5"]
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
		}
	]
}

Nota

title	Nota: HTTP Status Code = 404 - Not Found

IntegrationHubId incorreto ou inválido

...

O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição.

Bloco de código

title	JSON
linenumbers	true

{
    "integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
	  "orderKeyType": "TABLE",
	  "orderKey": []
}

Bloco de código

title	HTTP Status Code 412 = Precpndition Failed
linenumbers	true

{
	"message": "NOT_FOUND",
	"code": 412
}

Nota

title	Nota: HTTP Status Code = 412 Precondition Failed

Alguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos.

...

O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.

Bloco de código

title	JSON da requisição
linenumbers	true

{
    "integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
	  "orderKeyType": "TABLE",
		"orderKey": ["5"]
}

Bloco de código

title	Resposta da última execução
linenumbers	true

{
	"success": true,
	"error": null,
	"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
	"orderKeyType": "TABLE",
	"orderKey": [
		"5"
	],
	"lastestUpdatedStatus": "2024-07-02 18:54:28",
	"items": [
		{
			"id": "de9fd388-c223-4325-a64d-08889250f839",
			"status": {
				"code": 504,
				"description": "OPEN_TABLE"
			},
			"deliveryAgent": null,
			"deliveryDateTime": null,
			"cancellationReason": null,
			"tableCardNumber": "5"
		}
	]
}

Nota

title	Nota: 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.

...

404 - Not Found

IntegrationHubId incorreto ou inválido

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral acesse a documentação clicando aqui.

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com valor integral, adicionais e descontos acesse a documentação clicando aqui.

...

04. LINKS
Âncora
links
links

New

Order - Cheio com adicionalAPI

Order Mesa -

Status

Itens Fracionando

API

New Order Mesa -

Get ConsumptionAPI Order Mesa - Consumption API Order Mesa - Payment API Order Mesa - Payment Result API Order Mesa - Get Cancelled Items API Order Mesa - Cancelled Items

Vários Itens

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

02.

EXEMPLO DE UTILIZAÇÃO
Âncora

utilizar

utilizar

03. EXEMPLO DE UTILIZAÇÃO

03. ERROS
Âncora
erros
erros

04. ERROS

04. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

01. VISÃO GERAL Âncoraver_geralver_geral

02.

EXEMPLO DE UTILIZAÇÃO Âncora

utilizar

utilizar

03. EXEMPLO DE UTILIZAÇÃO

03. ERROS Âncoraerroserros

04. ERROS

04. LINKS Âncoralinkslinks

01. VISÃO GERAL
Âncora
ver_geral
ver_geral

EXEMPLO DE UTILIZAÇÃO
Âncora

03. ERROS
Âncora
erros
erros

04. LINKS
Âncora
links
links