CLIKSYS API DE INTEGRAÇÃO

Ambiente para desenvolvedores

Estas informações poderão ser alterados sem aviso prévio

Primeiros passos

As requisições feitas na API de integração devem conter nos dados do cabeçalho os seguintes campos.

Parâmetros de envio
Parâmetro Descrição
Token Token de acesso
Customer Nome da empresa

Funções

Código 401 – Erro na autenticação

{ "status": "401" "error": "Unauthorized" "message": "Problema com token" }

Códigos de retorno

STATUS ERROR MESSAGE
400 Bad Request Campos enviados com valores inválidos ou ausêntes
401 Unauthorized Problema com o Token utilizado
404 Not Found O caminho/url não foi encontrado
200 Ok Requisição processada com sucesso

Obtem Token de acesso

url: https://api.cliksys.com.br/authorize

Parâmetros de envio
Parâmetro Tipo Valor Descrição
user String api Nome do usuário de acesso
pass String 123 Senha para o usuário de acesso

Retorno Exemplo

Código 200 – OK

{ "token": "AXBpLmY0MTM0MDc0Yjc5ZmAPITE5NWVmNTBhITM2NT9xYmU0", "status": true }

Obtem lista de pedidos

url: https://api.cliksys.com.br/orders

Parâmetros de envio
Parâmetro Tipo Valor Descrição
startDate date 2021-01-27 Data inicial, se enviado em branco e caso flag for 0 retorna todos os não confirmados, senão se flag for 1 retorna da data atual
endDate date 2021-01-27 Data final, se enviado em branco e caso flag for 0 retorna todos os não confirmados, senão se flag for 1 retorna da data atual
flag Int 0 0 = Retorna vendas não confirmadas
1 = Retorna as vendas já confirmadas
Se enviar em branco ou não enviar retorna ambas as vendas.

Retorno Exemplo

Código 200 – OK

[{ "orderId": "220820191741203", //Id do pedido "customerName": "JOÃO DA SILVA", // Nome do Cliente "date": "2019-08-22", //Data do pedido "time": "17:41:21", //Hora do pedido "subTotal": "49.99", //Subtotal do pedido "promotion": "0.00", //Valor da promoção "discount": "0.00", //Valor do desconto "addition": "0.00", //Valor do acrescimo "deliveryFee": "0.00", //Valor da taxa de entrega "totalPrice": "49.99", //Total do pedido "type": "WB", //Tipo do pedido (WB - Web Balcão, WE - Web Entrega, TE - Tele Entrega e TB - Tele Balcão "status": "F", //Status do pedido (F - Finalidade e Confirmado, A - Aberto aguardando confirmação e C - Cancelado) "prints": "1", //Contador de impressão do pedido "orderSeq": "1", //Sequencial diario para cada tipo de pedido na mesma data "flag": "1" //Identificador de confimação do pedido (0 - Não Confirmado e 1 - Confirmado) }, { "orderId": "220808191812331", "customerName": "MARIA DA SILVA", "date": "2019-08-22", "time": "18:12:33", "subTotal": "20.00", "promotion": "0.00", "discount": "0.00", "addition": "0.00", "deliveryFee": "2.00", "totalPrice": "22.00", "type": "WE", "status": "A", "prints": "0", "orderSeq": "1", "flag": "0" }]

Obtem o pedido

url: https://api.cliksys.com.br/order/orderId

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "orderId": "160820191909575", //Id do pedido "date": "2019-08-16", //Data do pedido "time": "19:12:44", //Hora do pedido "countItems": "5", //Quantidade de itens no pedido "subTotal": "92.25", //Subtotal do pedido "promotion": "9.00", //Valor da promoção do pedido "discount": "0.00", //Valor do desconto "addition": "0.00", //Valor do acrescimo "deliveryFee": "3.00", //Valor da taxa de entrega "totalPrice": "86.25", //Total do pedido "cashChange": "0.00", //Valor do troco em dinheiro "type": "WE", //Tipo do pedido (WB - Web Balcão, WE - Web Entrega, TE - Tele Entrega e TB - Tele Balcão "status": "A", //Status do pedido (F - Finalidade e Confirmado, A - Aberto aguardando confirmação e C - Cancelado) "orderSeq": "12", //Sequencial diario para cada tipo de pedido na mesma data "observations": "", //Obervações gerais do pedido "firstOrder": "", //Mensagem quando do primeiro pedido do cliente "countPrinting": "0", //Contador de impressão do pedido "flag": "1", //Identificador de confimação do pedido (0 - Não Confirmado e 1 - Confirmado) "payments": [{ //Informações sobre os pagamentos "id": "3", //Id da forma de pagamento "code": "0", //Código no PDV da forma de pagamento "name": "CARTAO CREDITO", //Nome forma de pagamento "value": "51.83", //Valor pago na forma de pagamento "prepaid": true, //Pedido pago ("true" ou "false") "gateway": "CIELO", //Gateway de processamento do pagamento "prepaidType": "CREDIT", //Tipo da forma de pagamento (CREDIT/DEBIT) "authorizationCode": "654321" //Código de autorização do pagamento }], "customer": { //Informações sobre o cliente "id": "160946182009501", //Id do cliente "code": "123456789", //Código no PDV do cliente "name": "VALTER VIEIRA", //Nome completo "cpfCnpj": "00000000000", //Documento CPF ou CNPJ "email": "[email protected]", //E-mail do cliente "dateBirth": "1981-10-17", //Data de nascimento "homePhone": "", //Telefone residencial "cellPhone": "48984386540", //Telefone celular "commercialPhone": "4834787234", //Telefone comercial "dateRegistration": "2007-09-03", //Data de cadastro "status": "A", //Status do cliente (A - Ativo, I - Inativo) "updateDate": "2021-01-27 08:19:17", //Data de alteração do cadastro "flag": "1" //Identificador de alteração do cliente (0 - Alterado e 1 - Sem alterações) }, "deliveryAddress": { //Informações do endereço de entrega "id": "160999182016141", //Id do endereço "code": "12346789", //Código no PDV do endereço "streetName": "RUA HELVECIO COELHO RODRIGUES", //Nome da rua "streetNumber": "540", //Número "apartmentNumber": "607", //Número do apartamento "apartmentName": "JAIME SCREMIN", //Nome do edificio "neighborhoodId": "7", //Id do bairro "neighborhoodCode": "99", //Código no PDV do bairro "neighborhoodName": "CENTRO", //Nome do bairro "neighborhoodUpdate": "2021-01-27 08:19:17", //Data de alteração do bairro "neighborhoodFlag": "1", //Identificador de alteração do bairro (0 - Alterado e 1 - Sem alterações) "cityId": "1", //Id da cidade "cityCode": "9", //Código no PDV da cidade "cityName": "CRICIÚMA", //Nome da cidade "cityUpdate": "2021-01-27 08:19:17", //Data de alteração da cidade "cityFlag": "1", //Identificador de alteração da cidade (0 - Alterado e 1 - Sem alterações) "stateId": "1", //Id do estado "stateCode": "27", //Código no PDV do estado "stateName": "Santa Catarina", //Nome do estado "stateUpdate": "2021-01-27 08:19:17", //Data de alteração do estado "stateFlag": "0", //Identificador de alteração do estado (0 - Alterado e 1 - Sem alterações) "postalCode": "88802070", //CEP "referenceColor": "BANCO COM JANELA AZUL", //Cor da casa ou local "referenceType": "MATERIAL", //Cor da casa ou local (MADEIRA/MATERIAL/MISTA) "complement": "FUNDOS DO MERCADO BISTEQUINHO", //Complemento do endereço "status": "A", //Status do endereço (A - Ativo, I - Inativo) "updateDate": "2021-01-27 08:19:17", //Data de alteração do endereço "flag": "1" //Identificador de alteração do endereço (0 - Alterado e 1 - Sem alterações) }, "items": [{ //Informações dos itens "item": "1", //Número do item "group": "1", //Número do grupo para itens compostos (Pizzas) "pizzaStructure": true, //Estrutura do item (Pizza) "uniqueSize": false, //Informa se o produto tem tamanho único "id": "54", //Id do produto "code": "0", //Código no PDV do produto "name": "PIZZA GIGANTE - PORTUGUESA", //Nome do produto "price": "83.25", //Valor do item "quantity": "0.250", //Quantidade do item "totalPrice": "20.81", //Total do item "observations": "", //Observações sobre o item "ingredientsRemove": "CEBOLA", //Ingrediente para remover "ingredientsExtra": "PALMITO", //Ingrediente extras para adicionar "type": { "id": "1", //Id do tipo do produto "name": "Pizza" //Nome do tipo }, "stuffedEdge": { "id": "4", //Id da borda (Pizzas e similares) "name": "Chocolate Branco", //Nome da borda "price": "12.00" //Valor da borda }, "size": { "id": "5", //Id do tamanho do produto "name": "Gigante" //Nome do tamanho }, "flavor": { "id": "11", //Id do sabor do produto "name": "PORTUGUESA" //Nome do sabor } }, { "item": "2", "group": "1", "id": "181", "code": "0", "name": "PIZZA GIGANTE FILE MIGNON", "price": "83.25", "quantity": "0.250", "totalPrice": "20.81", "observations": "", "ingredientsRemove": "", "ingredientsExtra": "", "type": { "id": "1", "name": "Pizza" }, "stuffedEdge": { "id": "4", "name": "Chocolate Branco", "price": "12.00" }, "size": { "id": "5", "name": "Gigante" }, "flavor": { "id": "43", "name": "FILE MIGNON" } }, { "item": "3", "group": "1", "id": "6012719112660", "code": "0", "name": "PIZZA GIGANTE PEPERONE", "price": "83.25", "quantity": "0.250", "totalPrice": "20.81", "observations": "", "ingredientsRemove": "", "ingredientsExtra": "", "type": { "id": "1", "name": "Pizza" }, "stuffedEdge": { "id": "4", "name": "Chocolate Branco", "price": "12.00" }, "size": { "id": "5", "name": "Gigante" }, "flavor": { "id": "62", "name": "PEPERONE" } }, { "item": "4", "group": "1", "id": "31362", "code": "0", "name": "PIZZA GIGANTE QUATRO QUEIJOS C/ BACON", "price": "83.25", "quantity": "0.250", "totalPrice": "20.82", "observations": "", "ingredientsRemove": "", "ingredientsExtra": "", "type": { "id": "1", "name": "Pizza" }, "stuffedEdge": { "id": "4", "name": "Chocolate Branco", "price": "12.00" }, "size": { "id": "5", "name": "Gigante" }, "flavor": { "id": "120", "name": "QUATRO QUEIJOS C/ BACON" } }, { "item": "5", "group": "2", "id": "5557", "code": "0", "name": "COCA-COLA ZERO 1,5 LITROS ", "price": "9.00", "quantity": "1.000", "totalPrice": "9.00", "observations": "", "ingredientsRemove": "", "ingredientsExtra": "", "type": { "id": "2", "name": "Bebidas" }, "stuffedEdge": [], "size": { "id": "15", "name": "1,5 LITROS" }, "flavor": { "id": "15", "name": "COCA-COLA ZERO" } } ], }

Confirma o recebimento do pedido

url: https://api.cliksys.com.br/order/orderId/confirm

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Pedido confirmado com sucesso" //Mensagem de confirmação }

Confirma a impressão do pedido

url: https://api.cliksys.com.br/order/orderId/printing

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Impressão confirmado com sucesso" //Mensagem de confirmação }

Cancelar pedido

url: https://api.cliksys.com.br/order/orderId/cancel

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Pedido cancelado com sucesso" //Mensagem de confirmação }

Liberar o pedido online

url: https://api.cliksys.com.br/online

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Liberado venda com online com sucesso" //Mensagem de confirmação }

Confirmar cadastro do cliente

url: https://api.cliksys.com.br/customer/customerId/confirm

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Confirmado os dados do cliente" //Mensagem de confirmação }

Atualiza Code PDV cadastro do cliente

url: https://api.cliksys.com.br/customer/customerId/code/customerCode

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Code PDV confirmado com sucesso" //Mensagem de confirmação }

Confirmar cadastro do endereço do cliente

url: https://api.cliksys.com.br/customer/customerId/address/addressId/confirm

Sem parâmetros de envio

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Confirmado os dados do cliente" //Mensagem de confirmação }

Altera o Preço do produto

url: https://api.cliksys.com.br/product/price

Parâmetros de envio
Parâmetro Tipo Valor Descrição
id Int 123 ID do produto (opcional ID/CODE)
code String 123 Code PDV do produto (opcional ID/CODE)
price double 0.01 Valor novo para produto maior que 0,00

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Confirmado o novo valor do produto" //Mensagem de confirmação }

Altera o Status do produto

url: https://api.cliksys.com.br/produtct/productId/status

Parâmetros de envio
Parâmetro Tipo Valor Descrição
status String AVAILABLE O valor para status do produto AVAILABLE ou UNAVAILABLE

Retorno Exemplo

Código 200 – OK

{ "status": true, //Status da confirmação "message": "Confirmado o Status do produto" //Mensagem de confirmação }