{"info":{"_postman_id":"e23ddcfe-ade6-8c92-e4cb-55727f86ece2","name":"Order API","description":"

Order API - Integração de pedidos

\n\n

A integração de pedidos Teknisa (Order API) possibilita que uma plataforma de terceiros transmita um pedido ao PDV Teknisa.

Os dados enviados serão validados pela API e caso todos os parâmetros atendam os requisitos estabelecidos na documentação técnica o pedido será persistido na base ORACLE do cliente. Posteriormente o PDV realizará a sincronia do pedido com a base SQL SRV (Filial) e após essa etapa estará disponível na tela Delivery do PDV.

\n\n

Credencias

Para usar a API é necessário que a plataforma externa solicite um Token de sua plataforma para a Teknisa ({{PLATFORM_TOKEN}})

Para solicitar este Token entrar em contato com a Teknisa no E-mail delivery@teknisa.com

\n\n

Autorização de Rotas

Autenticação de Rota por meio do cabeçalho da requisição

Header - Authorization: bearer {{PLATFORM_TOKEN}}

\n\n

Considerações da API

\n\n

Para que a integração funcione da maneira esperada levantamos algumas considerações para os seguintes tópicos:

Datas: Devem ser enviadas no padrão “DD/MM/YYYY HH24:MI:SS” ou “DD/MM/YYYY”;
Validação Consumidor: Tem como pré-requisito o e-mail do consumidor;
Vendedor Padrão: Deve ser parametrizado previamente para funcionar a integração.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Order API - Integração de pedidos","slug":"order-api-integracao-de-pedidos"},{"content":"Considerações da API","slug":"consideracoes-da-api"}],"owner":"4067667","collectionId":"e23ddcfe-ade6-8c92-e4cb-55727f86ece2","publishedId":"RWEgpdgc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-05T14:37:31.000Z"},"item":[{"name":"Order","item":[{"name":"order","event":[{"listen":"test","script":{"id":"b0e7c687-ca2b-4985-ba58-9fff72635d87","exec":["console.log('test');"],"type":"text/javascript"}}],"id":"490bc88f-e063-9965-bd5c-c9048d0039da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"bearer {{PLATFORM_TOKEN}}"}],"body":{"mode":"raw","raw":"{\n\t\"saleId\": \"10592\",\n\t\"orderNumber\": \"1004\",\n\t\"orderType\": 1,\n\t\"date\": \"2018-08-20 18:54:16\",\n\t\"scheduleDate\": \"2018 - 09 - 22 10: 30: 00\",\n\t\"subsidiaryCode\": \"0107\",\n\t\"tax\": 10.0,\n\t\"subTotal\": 60.0,\n\t\"total\": 70.0,\n\t\"troco\": 0,\n\t\"discount\": 0,\n\t\"latitude\": 0.0,\n\t\"longitude\": 0.0,\n\t\"cpfInNote\": \"\",\n\t\"notes\": \"\",\n\t\"consumerDetail\": {\n\t\t\"clientId\": \"562122\",\n\t\t\"name\": \"Cliente Teste\",\n\t\t\"email\": \"clienteTeste26@gmail.com\",\n\t\t\"phone\": \"(11) 33332222\",\n\t\t\"cellPhone\": \"(11) 999999999\",\n\t\t\"cpf\": \"\",\n\t\t\"address\": {\n\t\t\t\"zipCode\": \"09605000\",\n\t\t\t\"street\": \"Avenida Senador Vergueiro\",\n\t\t\t\"number\": \"4605\",\n\t\t\t\"neighborhood\": \"Rudge Ramos\",\n\t\t\t\"city\": \"São Bernardo Do Campo\",\n\t\t\t\"uf\": \"SP\",\n\t\t\t\"complement\": \"\",\n\t\t\t\"referencePoint\": \"empresa de onibus kuba\"\n\t\t}\n\t},\n\t\"payments\": [\n\t\t{\n\t\t\t\"paymentId\": \"999\",\n\t\t\t\"value\": 70\n\t\t}\n\t],\n\t\"ItemOrder\": [\n\t\t{\n\t\t\t\"title\": \"Jalapeno Bacon Burger\",\n\t\t\t\"quantity\": 3,\n\t\t\t\"price\": 20,\n\t\t\t\"total\": 60,\n\t\t\t\"notes\": \"\",\n\t\t\t\"ref\": \"8.31.06.091.00\",\n\t\t\t\"ComplementCategories\":\n\t\t\t[\n\t\t\t\t{\n\t\t\t\t\t\"title\": \"Ao Ponto\",\n\t\t\t\t\t\"quantity\": 1,\n\t\t\t\t\t\"priceUn\": 0,\n\t\t\t\t\t\"total\": 0,\n\t\t\t\t\t\"ref\": \"06@03\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"{{apiURI}}/order","description":"

Order - Salvar Comanda

\n\n

Processa um pedido do tipo delivery ou to go (Retirada na Loja).

\n\n

Method: POST

\n\n

Parâmetros

\n\n

PARAM	REQUIRED	DESCRIPTION
saleId	true	Identificador único do pedido na plataforma de terceiros
orderNumber	true	Identificador resumido do pedido na plataforma de terceiros. (4 digitos)
orderType	true	Tipo do pedido delivery (1) ou retirada na loja (2).
origin	true	Origem do pedido (identificação da plataforma de terceiros - 5 caracteres - Ex: PLA01 (Plataforma Ficticia 1).
date	true	Data que o pedido foi realizado na plataforma.
scheduleDate	true	Data para agendar o pedido dentro do sistema (enviar somente em pedidos agendados).
subsidiaryCode	true	Código da filial no sistema Teknisa
tableNumber	false	Código da mesa no sistema Teknisa
tax	true	Taxa de entrega do pedido (enviar 0 quando não houver).
subTotal	true	Somatoria dos produtos + acréscimos.
total	true	Total do pedido (Subtotal + taxa de entrega - descontos).
troco	true	'Troco para' do pedido.
discount	true	Valor de desconto total que será rateado entre os itens do pedido.
latitude	true	Latitude do local de entrega do pedido.
longitude	true	Longitude do local de entrega do pedido.
cpfInNote	true	CPF para impressão na nota.
notes	true	Observação geral do pedido (máximo: 100 caracteres).
consumerDetail	true	Objeto: Detalhes do Consumidor.
payments	true	Objeto: Detalhes do Pagamento realizado.
ItemOrder	true	Objeto: Detalhes do Pedido para produto Simples.

\n\n

Consumer Details - Detalhes do consumidor

\n\n

PARAM	REQUIRED	DESCRIPTION
clientId	true	Identificador único do consumidor na plataforma de terceiros.
name	true	Nome do consumidor (máximo: 50).
email	true	E-mail do consumidor (máximo: 50).
phone	true	telefone fixo do consumidor (enviar vazio quando não existir)
cellPhone	true	telefone celular do consumidor (enviar vazio quando não existir)
cpf	true	CPF do consumidor (enviar vazio quando não existir)
address	true	Objeto: Endereço do consumidor completo. (enviar vazio para pedidos com modalidade to go / retirada na loja)

\n\n

Address - Endereço do Consumidor

\n\n

PARAM	REQUIRED	DESCRIPTION
zipCode	true	CEP do consumidor.
street	true	Rua do consumidor (máximo: 50).
number	true	Número do consumidor.
neighborhood	true	Bairro do consumidor (máximo: 100).
city	true	Cidade do consumidor.
uf	true	Sigla do estado.
complement	true	Complemento do consumidor (enviar vazio quando não existir).
referencePoint	true	Referência do endereço do consumidor (enviar vazio quando não existir).

\n\n

Payments

\n\n

PARAM	REQUIRED	DESCRIPTION
paymentId	true	Identificador de pagamento na plataforma de terceiros.
value	true	Valor do pagamento.

\n\n

Topo

Produto

\n\n

PARAM	REQUIRED	DESCRIPTION
title	true	Nome do Item.
quantity	true	Quantidade do Item.
price	true	Preço unitário do Item principal.
total	true	Total do Item (somado ao preço dos acréscimos, quando houver).
notes	true	Observação escrita para o Item.
ref	true	Código de produto do Item.
ComplementCategories	true	Complementos do item (Acréscimos, Retiradas e/ou Observações Adicionais).

\n\n

Voltar

Complementos do Item (Objeto)

\n\n

PARAM	REQUIRED	DESCRIPTION
title	true	Nome do Item.
quantity	true	Quantidade do Item.
priceUn	true	Preço unitário (Caso exista).
total	true	Total de preço unitário x quantidade.
ref	true	Código da Observação/Adicional.

\n\n

Topo

Estrutura:

\n\n

{\n    \"saleId\": \"0000001\", \n    \"orderNumber\": \"0001\", \n    \"orderType\": 1, \n    \"date\": \"2020-01-01 18:00:00\", \n    \"scheduleDate\": \"\", \n    \"subsidiaryCode\": \"0005\",\n    \"tableNumber\": \"\",\n    \"tax\": 10.0, \n    \"subTotal\": 50.0,  \n    \"total\": 60.0, \n    \"troco\": 0.0, \n    \"discount\": 0.0, \n    \"latitude\": 0.0, \n    \"longitude\": 0.0, \n    \"cpfInNote\": \"\", \n    \"notes\": \"\", \n    \"consumerDetail\": {\n        \"clientId\": \"123456789\", \n        \"name\": \"Cliente\", \n        \"email\": \"cliente.teste@gmail.com\", \n        \"phone\": \"1133332222\", \n        \"cellPhone\": \"11999999999\", \n        \"cpf\": \"\", \n        \"address\": {\n            \"zipCode\": \"09605000\", \n            \"street\": \"Avenida Senador Vergueiro\", \n            \"number\": \"4605\", \n            \"neighborhood\": \"Rudge Ramos\", \n            \"city\": \"São Bernardo Do Campo\", \n            \"uf\": \"SP\", \n            \"complement\": \"\", \n            \"referencePoint\": \"empresa de onibus\" \n        }\n    },\n    \"payments\": [\n        {\n            \"paymentId\": \"001\", \n            \"value\": 50.0 \n        }\n    ],\n    \"ItemOrder\": [\n        { \n            \"title\": \"BACON BURGUER\", \n            \"quantity\": 2, \n            \"price\": 20, \n            \"total\": 40, \n            \"notes\": \"\", \n            \"ref\": \"8.31.06.091.00\", \n            \"ComplementCategories\": [\n                { \n                    \"title\": \"Ao Ponto\", \n                    \"quantity\": 1, \n                    \"priceUn\": 0, \n                    \"total\": 0, \n                    \"ref\": \"06|03\" \n                }\n            ]\n        }\n    ]\n}\n\n

","urlObject":{"path":["order"],"host":["{{apiURI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"490bc88f-e063-9965-bd5c-c9048d0039da"},{"name":"orderStatus","event":[{"listen":"test","script":{"id":"b0e7c687-ca2b-4985-ba58-9fff72635d87","exec":["console.log('test');"],"type":"text/javascript"}}],"id":"6f7dc2b4-dc4e-40f1-aaae-39229715a8b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"bearer {{PLATFORM_TOKEN}}"}],"body":{"mode":"raw","raw":"{\n\t\"orderId\": \"10592\"\n}"},"url":"{{apiURI}}/orderStatus","description":"

Order - Status

\n\n

Consulta ao status do pedido dentro do sistema Teknisa.

Method: POST

\n\n

Parâmetros

\n\n\n \n \n \n \n \n \n \n \n \n \n

PARAM	REQUIRED	DESCRIPTION
orderId	true	Identificador único do pedido

\n\n\n

Dicionário de Status

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

STATUS	DESCRIPTION
PRODUCAO	Pedido em produção
IMPRESSO	Pedido impresso (cupom fiscal)
EXPEDIDO	Pedido expedido (saiu para entrega)
FINALIZADO	Pedido finalizado
CANCELADO	Pedido cancelado

\n\n\n

Retorno

\n\n

{\n    \"orderStatus\": \"CANCELADO\" \n}\n

","urlObject":{"path":["orderStatus"],"host":["{{apiURI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f7dc2b4-dc4e-40f1-aaae-39229715a8b3"}],"id":"88e9cda4-1abe-5f25-bea3-86fa2ee71530","_postman_id":"88e9cda4-1abe-5f25-bea3-86fa2ee71530","description":""},{"name":"Menu","item":[{"name":"menu (Beta)","id":"3071189b-1927-4669-a86c-7eaa9865b2ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"bearer {{PLATFORM_TOKEN}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"branchId\": \"0005\"\n}"},"url":"{{apiURI}}/menu","description":"

Menu - Busca Cardápio

\n\n

Busca de cardápio vigente para a loja relacionado aos produtos do Delivery.

Method: POST

\n\n

Parâmetros

\n\n\n \n \n \n \n \n \n \n \n \n \n

PARAM	REQUIRED	DESCRIPTION
saleId	true	Identificador do pedido (cód. Pedido)

\n\n

Estrutura:

\n\n

{\n    \"branchId\": \"0005\"\n}\n

Retorno:

\n\n

Estrutura de retorno do Endpoint de buscar o menu:

Method: Json

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
success	Estado da requisição de resposta para o cliente [200: OK, 400: FAIL]
menu	Objeto que carrega todos os dados necessários para a consulta do menu
erroMessage?	Mensagem de erro, apenas aparece quando a requisição falha ou uma excessão é levantada [400: FAIL]

\n\n

Layout Agrupador de Produtos

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
groupName	Nome do Agrupador de produtos ex: BEBIDAS
products	Array de Objetos carrega todos os dados dos produtos vinculados ao seu agrupador

\n\n

Layout Produtos [Combo, Simples]

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
itemName	Nome do item, ex: \"SUCO ABACAXI\"
itemId	Identificador do item na base Teknisa
itemModifierId	Modificador do tipo do item [(0, 1) -> Produto simples; (2, 3) -> Promoção Combo]
itemValue	Valor final do item (com descontos da tabela de preço vigente)
itemSubProducts	Array de Objetos produtos existem dentro deste item (para combos)

\n\n

Layout de Grupo de Subprodutos (Combos)

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
subProductGroupName	Nome do Agrupador de subprodutos ex: REFRIGERANTES - 300 ml
subProductGroupId	Identificador do subgrupo na base Teknisa
subProductsGroupLimit	Limite criado pelo cliente para quantidade total de produtos deste tipo dentro do combo, ex: \"1\" [Escolha apenas um Refrigerante]
subProductGroupItems	Array de Objetos Lista de itens dentro do Agrupador deste Combo para a seleção.

\n\n

Layout de Subitens (Combos)

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
subItemName	Nome do subitem ex: REFRI 300 COCA-COLA
subItemId	Identificador do subitem na base Teknisa
subItemValue	Valor do subitem dentro deste combo
subItemDiscountValue	Valor de desconto do subitem (Caso o tipo de desconto for porcentagem (\"P\") o valor estará entre [0, 1] ex: 0.5 -> 50%)
subItemDiscountType	Modificador do tipo de desconto, pode ser porcentagem ou valor absoluto = [\"P\", \"V\"]

\n\n

Produto Pizzas

\n\n

Produto Pizza (Caso Exista)

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
pizzaName	Nome do agrupador da PIZZA ex: PIZZA SIMPLES
pizzaValue	Valor da Pizza (Como é uma seleção de itens vira zerada)
pizzaLimit	Limite de pizzas a serem selecionadas (pertence ao layout vigente do cliente)
pizzaTaxMethod	Metodo de cobrança da Pizza (\"M\" -> media das Pizzas, \"C\" -> cobra o maior Preço)
products	Array de objetos produtos que compõe o agrupador da pizza

\n\n

Layout de produtos (Pizza)

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
nameSubItem	Nome do agrupador da PIZZA ex: PIZZA SIMPLES
subItemId	Valor da Pizza (Como é uma seleção de itens vira zerada)
productId	Limite de pizzas a serem selecionadas (pertence ao layout vigente do cliente)
description	Descrição da fatia da Pizza
value	Valor da fatia da Pizza

\n\n

Observações do Menu (Layout de Observações)

\n\n

Estrutura de menu para carregar as observações:

\n\n\n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
Observations	Array de Objetos Agrupador de todas as observações

\n\n

Primeiro nivel: Grupo de Observações

\n\n\n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
{{Identificador do Grupo de Observação}}	Codigo Teknisa do Grupo de Observações

\n\n

Segundo nivel: Identificador da Observação

\n\n\n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
{{Identificador da Observação}}	Codigo Teknisa da Observações (Dois dígitos)

\n\n

Terceiro nivel: Tipo da Observação

\n\n\n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
{{Tipo da Observação}}	Tipos de Observação [\"O\" -> Observação simples; \"A\" -> Adicionais; \"R\" -> Observações do tipo Retirada]

\n\n

Quarto nivel: Produtos por Observação

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

DATA	DESCRIPTION
observationName	Nome da Observação
observationId?	Caso a Observação seja do tipo \"A\" existirá um identificador teknisa atrelado a ela
observationValue?	Valor da observação - Apenas para observações do tipo \"A\"
products	Array Simples contém todos os identificadores dos produtos, que tenham esta Observação vinculada

\n\n

{\n  \"success\": true,\n  \"menu\": {\n    \"Products\": [\n      {\n        \"groupName\": \"BEBIDAS\",\n        \"products\": [\n          {\n            \"itemName\": \"SUCO ABACAXI\",\n            \"itemId\": \"8011100100\",\n            \"itemModifierId\": \"0\",\n            \"itemValue\": 9.9,\n            \"itemSubProducts\": []\n          }\n        ]\n      },\n      {\n        \"gruoupName\": \"COMBOS\",\n        \"products\": [\n          {\n            \"itemName\": \"PORCAO DE ABACAXI\",\n            \"itemId\": \"8360605100\",\n            \"itemModifierId\": \"3\",\n            \"itemValue\": 0,\n            \"itemSubProducts\": [\n                {\n                    \"subProductsGroupName\": \"TACA SIMPLES\",\n                    \"subProductsGroupId\": \"0000000034\",\n                    \"subProductsGroupLimit\": \"1\",\n                    \"subProductsGroupItems\": [\n                        {\n                            \"subItemName\": \"TACA SIMPLES\",\n                            \"subItemId\": \"9011800121\",\n                            \"subItemValue\": 8.091,\n                            \"subItemDiscountValue\": 0.9,\n                            \"subItemDiscountType\": \"P\"\n                        }\n                    ]\n                }\n            ]\n          },\n          {\n            \"itemName\": \"COMBO X CHICKEN\",\n            \"itemId\": \"9020600102\",\n            \"itemModifierId\": \"3\",\n            \"itemValue\": 0,\n            \"itemSubProducts\": [\n                {\n                    \"subProductsGroupName\": \"PORCOES\",\n                    \"subProductsGroupId\": \"0000000005\",\n                    \"subProductsGroupLimit\": \"2\",\n                    \"subProductsGroupItems\": [\n                        {\n                            \"subItemName\": \"BATATA CHEDDAR + BACON\",\n                            \"subItemId\": \"9020700109\",\n                            \"subItemValue\": 5.9,\n                            \"subItemDiscountValue\": 3.9,\n                            \"subItemDiscountType\": \"V\"\n                        },\n                        {\n                            \"subItemName\": \"BATATA FRITA\",\n                            \"subItemId\": \"9020700110\",\n                            \"subItemValue\": 2,\n                            \"subItemDiscountValue\": 3.9,\n                            \"subItemDiscountType\": \"V\"\n                        }\n                    ]\n                }\n            ]\n            \n          }\n      ]\n      },\n      {\n        \"groupName\": \"PIZZAS\",\n        \"pizzaProducts\": [\n          {\n            \"pizzaName\": \"PIZZA PEQUENA\",\n            \"pizzaPrice\": 0,\n            \"pizzaLimit\": \"4\",\n            \"pizzaTaxMethod\": \"M\",\n            \"products\": [\n              {\n                \"nameSubItem\": \"CALABRESA\",\n                \"idSubItem\": \"8360602200\",\n                \"idProduct\": \"8360602200\",\n                \"description\": null,\n                \"price\": 12.75\n              },\n              {\n                \"nameSubItem\": \"PEPPERONI\",\n                \"idSubItem\": \"101010010000\",\n                \"idProduct\": \"101010010000\",\n                \"description\": null,\n                \"price\": 0\n              },\n              {\n                \"nameSubItem\": \"MUZZARELLA\",\n                \"idSubItem\": \"9012200142\",\n                \"idProduct\": \"9012200142\",\n                \"description\": null,\n                \"price\": 4\n              }\n            ]\n          }\n        ]\n      }\n    ],\n    \"Observations\": [\n      {\n        \"01\": {\n          \"10\": {\n            \"O\": {\n              \"observationName\": \"GELO LIMAO\",\n              \"products\": [\n                \"8010100100\"\n              ]\n            },\n            \"A\": [],\n            \"R\": []\n          },\n          \"18\": {\n            \"O\": [],\n            \"A\": [],\n            \"R\": {\n              \"observationName\": \"SEM CHANTILLY\",\n              \"products\": [\n                \"8110100100\",\n                \"8110100200\"\n              ]\n            }\n          },\n          \"88\": {\n            \"O\": [],\n            \"A\": {\n              \"observationName\": \"CANUDO DE CHOCOLATE\",\n              \"observationId\": \"8110109500\",\n              \"observationValue\": 1,\n              \"products\": [\n                \"8110109100\"\n              ]\n            },\n            \"R\": []\n          }\n        }\n      }\n    ]\n  }\n}\n

","urlObject":{"path":["menu"],"host":["{{apiURI}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3071189b-1927-4669-a86c-7eaa9865b2ec"}],"id":"ed3b22f5-e110-4c2d-939e-126bde7b6953","description":"

Menu request API Delivery

\n","_postman_id":"ed3b22f5-e110-4c2d-939e-126bde7b6953"}],"event":[{"listen":"prerequest","script":{"id":"b5a14497-4fc9-4dfe-b32c-0721bc53ba1f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bcd742fe-06ef-4aeb-acfa-8067b5995b99","type":"text/javascript","exec":[""]}}]}