Criação Automatizada de Entidades

Última atualização: 26 de setembro de 2019

Introdução

API destinada para criação de novas entidades a partir dos Parceiros.

Operações API


Consulta de Produtos

Requisição
GET https://apix.clearsale.com.br/clearsale/products HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
GET https://homologapix.clearsale.com.br/clearsale/products HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
Resposta
RESPONSE HEADER
Content-Type: application/json
Charset=uft-8

RESPONSE BODY
HTTP/1.1 200 OK

  [
      {
          "id": 1,
          "name": "Application"
      },
      {
          "id": 3,
          "name": "Total Clearsale"
      },
      {
          "id": 4,
          "name": "Total Garantido Clearsale"
      }
  ]

Consulta de Segmentos

Requisição
GET https://apix.clearsale.com.br/clearsale/segments HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
GET https://homologapix.clearsale.com.br/clearsale/segments HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
Resposta
RESPONSE HEADER
Content-Type: application/json
Charset=uft-8

RESPONSE BODY
HTTP/1.1 200 OK

  [
      {
          "id": 2,
          "name": "Calçados"
      },
      {
          "id": 7,
          "name": "Beleza Produtos Nacionais"
      },
      {
          "id": 14,
          "name": "Rodoviários"
      },
      {
          "id": 31,
          "name": "Games e Informática"
      },
      {
          "id": 55,
          "name": "Artigos Esportivos + Tênis Esportivos"
      },
      {
          "id": 49,
          "name": "Eletrodomésticos"
      },
      {
          "id": 50,
          "name": "Magazine"
      }
  ]

Solicitação de Cotação

Requisição
POST https://apix.clearsale.com.br/clients/pricequotes HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}

REQUEST BODY

  {
    "clientID": "ID_Do_Cliente",
    "tradingName": "Loja de Teste",
    "clearsaleProduct": 3,
    "marketedProducts": 7,
    "mediumTicket": 250.00,
    "orderQuantity": 250,
    "documentType": 1,
    "document": "12345678912345",
    "contactName": "João da Silva",
    "storeEmail": "loja.teste@lojadeteste.com.br"
  }
POST https://homologapix.clearsale.com.br/clients/pricequotes HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}

REQUEST BODY

  {
    "clientID": "ID_Do_Cliente",
    "tradingName": "Loja de Teste",
    "clearsaleProduct": 3,
    "marketedProducts": 7,
    "mediumTicket": 250.00,
    "orderQuantity": 250,
    "documentType": 1,
    "document": "12345678912345",
    "contactName": "João da Silva",
    "storeEmail": "loja.teste@lojadeteste.com.br"
  }
Resposta
RESPONSE HEADER
Content-Type: application/json
Charset=uft-8

RESPONSE BODY
HTTP/1.1 200 OK

Response:
  {
    "transactionCode": "ad71f06c-93db-4fab-b1a2-358c327f75e7",
    "priceType": 1,
    "nominalValueQuotation": 300.00,
    "percentageValueQuotation": 15.6
  }

Criação da Nova Entidade

Requisição
POST https://apix.clearsale.com.br/clients HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}

REQUEST BODY

  {
    "clientID": "ID_Do_Cliente",
    "entityName": "LojaDeTeste",
    "businessName": "Loja de Teste LTDA",
    "tradingName": "Loja de Teste",
    "urlWebHook": "https://lojadeteste.com.br/webhookclearsale",
    "clearsaleProduct": 3,
    "marketedProducts": 7,
    "mediumTicket": 250.00,
    "orderQuantity": 250,
    "documentType": 1,
    "document": "70407743000166",
    "contactName": "João da Silva",
    "contactEmail": "joaosilva@lojadeteste.com.br",
    "contactPhone": "11955556666",
    "storeUrl": ["www.lojadeteste.com.br","lojateste.com.br"],
    "storeEmail": "loja.teste@lojadeteste.com.br",
    "transactionCode": "ad71f06c-93db-4fab-b1a2-358c327f75e7",
    "priceType": 1,
    "nominalValueQuotation": 300.00,
    "percentageValueQuotation": 15.6
  }
POST https://homologapix.clearsale.com.br/clients HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}

REQUEST BODY

  {
    "clientID": "ID_Do_Cliente",
    "entityName": "LojaDeTeste",
    "businessName": "Loja de Teste LTDA",
    "tradingName": "Loja de Teste",
    "urlWebHook": "https://lojadeteste.com.br/webhookclearsale",
    "clearsaleProduct": 3,
    "marketedProducts": 7,
    "mediumTicket": 250.00,
    "orderQuantity": 250,
    "documentType": 1,
    "document": "70407743000166",
    "contactName": "João da Silva",
    "contactEmail": "joaosilva@lojadeteste.com.br",
    "contactPhone": "11955556666",
    "storeUrl": ["www.lojadeteste.com.br","lojateste.com.br"],
    "storeEmail": "loja.teste@lojadeteste.com.br",
    "transactionCode": "ad71f06c-93db-4fab-b1a2-358c327f75e7",
    "priceType": 1,
    "nominalValueQuotation": 300.00,
    "percentageValueQuotation": 15.6
  }
Resposta
RESPONSE HEADER
Content-Type: application/json
Charset=uft-8

RESPONSE BODY
HTTP/1.1 200 OK

Response:
  {
    "clientID": "ID_Da_Loja",
    "apiUser": "LojaDeTeste",
    "apiPassword": "AbcX123B1",
    "fingerPrintAppKey": "ah2243cvdlew8fa"
  }

Inativar Entidade

Requisição
PUT https://apix.clearsale.com.br/clients/status HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}

REQUEST BODY

   {
     "clientID": "ID_Do_Cliente"
   }
PUT https://homologapix.clearsale.com.br/clients/status HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}

REQUEST BODY

   {
     "clientID": "ID_Do_Cliente"
   }
Resposta
RESPONSE HEADER
Content-Type: application/json
Charset=uft-8

RESPONSE BODY
HTTP/1.1 200 OK

Response:
  {
    "status": "OK",
    "message": "entity disabled"
  }

Tabelas código e descrição


Tipo de Documentos


ID Produto
1 CNPJ
2 CPF

Descrição de campos


Requisição da Cotação


Propriedades Descrição Tipo Tamanho Obrigatório
clientID ID do cliente string 50 S
tradingName Nome Fantasia da loja string 200 S
clearsaleProduct Produto ClearSale Contratado integer - S
marketedProducts Produtos vendidos na loja (calçados, eletrônicos etc.) integer - S
mediumTicket Ticket médio da loja decimal 20,4 S
orderQuantity Volume de pedidos por mês vendido pela loja integer - S
documentType Tipo do documento integer - S
document CNPJ da loja ou CPF da pessoa string 50 S
contactName Nome do contato responsável pela loja string 100 S
storeEmail E-mail da Loja string 150 S

Resposta da Cotação


Propriedades Descrição Tipo Tamanho
transactionCode Código informado pela API de Cotação de Preço string 50
priceType Tipo do Preço integer -
nominalValueQuotation Valor recebido no momento da cotação de preços decimal 20,4
percentageValueQuotation Valor recebido no momento da cotação de preços decimal 20,4

Requisição da Entidade


Propriedades Descrição Tipo Tamanho Obrigatório
clientID ID do cliente string 50 S
entityName Nome da loja string 100 S
businessName Razão social da loja string 200 S
tradingName Nome Fantasia da loja string 200 N
urlWebHook URL para disparo de notificação de alteração de status string 400 S
clearsaleProduct Produto ClearSale Contratado integer - S
marketedProducts Produtos vendidos na loja (calçados, eletrônicos etc.) integer - N
mediumTicket Ticket médio da loja decimal 20,4 N
orderQuantity Volume de pedidos por mês vendido pela loja integer - N
documentType Tipo do documento integer - N
document CNPJ da loja ou CPF da pessoa string 50 N
contactName Nome do contato responsável pela loja string 100 N
contactEmail E-mail do contato responsável pela loja string 150 S
contactPhone Telefone do contato responsável pela loja string 25 S
storeUrl URL do site da loja array(string) 256 S
storeEmail E-mail da Loja string 150 N
transactionCode Código informado pela API de Cotação de Preço string 50 S
priceType Tipo do Preço integer - S
nominalValueQuotation Valor recebido no momento da cotação de preços. decimal 20,4 S
percentageValueQuotation Valor recebido no momento da cotação de preços. decimal 24,0 S

Resposta da Entidade


Propriedades Descrição Tipo Tamanho
clientID ID do cliente string 50
apiUser Nome de usuário da API string 50
apiPassword Senha do usuário da API string 50
fingerPrintAppKey Chave para a configuração do fingerprint na loja string 20