Criação Automatizada de Entidades

Última atualização: 26 de Outubro de 2021

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/partners/clients/products/segments HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
GET https://homologapix.clearsale.com.br/partners/clients/products/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": 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/partners/clearsale/segments HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
GET https://homologapix.clearsale.com.br/partners/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"
      }
  ]

Consulta de Produtos e Segmentos

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

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
GET https://homologapix.clearsale.com.br/partners/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

 {
    "produtos": [
        {
            "id": "21",
            "nome": "Realtime Management",
            "frentes": [
                {
                    "id": "1",
                    "nome": "Acessórios e Bijuterias"
                },
                {
                    "id": "3",
                    "nome": "Ar Condicionado"
                },
                {
                    "id": "4",
                    "nome": "Artigos de Festa"
                },
                {
                    "id": "5",
                    "nome": "Artigos de tiro"
                },
                {
                    "id": "6",
                    "nome": "Artigos Esportivos + Tênis Esportivos"
                },
                {
                    "id": "7",
                    "nome": "Artigos Infantis/Brinquedos"
                },
                {
                    "id": "8",
                    "nome": "Automotivo (geral)"
                }
            ]
        }
    ]
}

Solicitação de Cotação [Deprecated]

Requisição
POST https://apix.clearsale.com.br/partners/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/partners/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
  }

Solicitação de Cotação

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

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

REQUEST BODY

{
    "idExternoProduto": 21,
    "idExternoFrente": 1,
    "ticketMedio": 105.00,
    "pedidos": 10,
    "nomeFantasiaLoja": "Nome Fantasia",
    "cnpj": "02668127000109",
    "nomeContatoResponsavel": "Nome Responsável",
    "email": "email@teste.com"
}
POST https://homologapix.clearsale.com.br/partners/clients/createquote HTTP/1.1

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

REQUEST BODY

{
    "idExternoProduto": 21,
    "idExternoFrente": 1,
    "ticketMedio": 105.00,
    "pedidos": 10,
    "nomeFantasiaLoja": "Nome Fantasia",
    "cnpj": "02668127000109",
    "nomeContatoResponsavel": "Nome Responsável",
    "email": "email@teste.com"
}
Resposta
/partners/clients/products/segments HTTP/1.1

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

RESPONSE BODY
HTTP/1.1 200 OK
{
    "transactionCode": "Q-99999"
}

Criação da Nova Entidade

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

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

REQUEST BODY

{
    "clientID": "ClientID",
    "entityName": "Entity Name",
    "businessName": "Business Name",
    "tradingName": "Trading Name",
    "entityPronunciation": "Entity Pronunciation",
    "urlWebHook": "http://www.webhook.com.br",
    "clearsaleProduct": 21,
    "marketedProducts": 1,
    "mediumTicket": 105.00,
    "orderQuantity": 10,
    "documentType": 1,
    "document": "27.446.238/0001-00",
    "contactName": "Nome Contato",
    "contactEmail": "contato@email.com",
    "contactPhone": "(12) 98888-8888",
    "storeUrl": [
        "www.urlloja.com.br"
    ],
    "storeEmail": "lojac@mail.com",
    "transactionCode": "Q-99999",
    "riskRange": 1
}
POST https://homologapix.clearsale.com.br/partners/clients HTTP/1.1

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

REQUEST BODY

{
    "clientID": "ClientID",
    "entityName": "Entity Name",
    "businessName": "Business Name",
    "tradingName": "Trading Name",
    "entityPronunciation": "Entity Pronunciation",
    "urlWebHook": "http://www.webhook.com.br",
    "clearsaleProduct": 21,
    "marketedProducts": 1,
    "mediumTicket": 105.00,
    "orderQuantity": 10,
    "documentType": 1,
    "document": "27.446.238/0001-00",
    "contactName": "Nome Contato",
    "contactEmail": "contato@email.com",
    "contactPhone": "(12) 98888-8888",
    "storeUrl": [
        "www.urlloja.com.br"
    ],
    "storeEmail": "lojac@mail.com",
    "transactionCode": "Q-99999",
    "riskRange": 1
}
Resposta
RESPONSE HEADER
Content-Type: application/json
Charset=uft-8

RESPONSE BODY
HTTP/1.1 204 OK NO CONTENT

Inativar Entidade

Requisição
PUT https://apix.clearsale.com.br/partners/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/partners/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"
  }

Consulta de Credenciais

Requisição
GET https://apix.clearsale.com.br/partners/entity/credentials?clientId={ClientID} HTTP/1.1

REQUEST HEADER
Content-Type: application/json
Accept: application/json
Authorization: Bearer {Token}
GET https://homologapix.clearsale.com.br/partners/entity/credentials?clientId={ClientID} 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

Response:
{
    "clientID": "testclient",
    "apiUser": "UsuarioTeste",
    "apiPassword": "qAoXafsr2Kf",
    "fingerprintKey": "pu00780t4o3yc92w",
    "applicationUser": "Loja de teste",
    "applicationPassword": "Oiy0780t4o3yc92w"
}

Tabelas código e descrição


Tipo de Documentos


ID Produto
1 CNPJ
2 CPF

Faixa de Risco


ID Descrição
1 Ultra Conservador
2 Conservador
3 Moderado
4 Agressivo

Descrição de campos


Requisição da Cotação [Deprecated]


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 [Deprecated]


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 Cotação


Propriedades Descrição Tipo Tamanho Obrigatório
idExternoProduto Produto ClearSale Contratado integer - S
idExternoFrente Produtos vendidos na loja (calçados, eletrônicos etc.) integer - S
ticketMedio Ticket médio da loja decimal 20,4 S
pedidos Volume de pedidos por mês vendido pela loja integer - S
nomeFantasiaLoja Nome Fantasia da loja string 200 S
CNPJ CNPJ da loja string 50 S
nomeContatoResponsavel Nome do contato responsável pela loja string 100 S
email 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 10

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
entityPronunciation Pronúncia do nome da loja string 180 S
urlWebHook URL para disparo de notificação de alteração de status string 400 N
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
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 - Apenas para usuários que utilizam cotação string 50 S
riskRange Faixa de risco dos pedidos da entidade. integer - N

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
applicationUser Nome de usuário da Aplicação string 100
applicationPassword Senha do usuário da Aplicação string 100

Webhook (endpoint) dos clientes

Webhook (endpoint) dos clientes para que as APIs da ClearSale enviem informações dos processos assíncronos (cotação e criação de entidade). Este endpoint (único) deve estar preparado para vários payloads diferentes, sendo diferenciados por um atributo "type" informado no próprio payload. Abaixo seguem as requisições que podem ser feitas a esse endpoint, separadas por tipo de payload.

Retorno de cotação assíncrona

Requisição
REQUEST HEADER
Content-Type: application/json
Accept: application/json

REQUEST BODY

**Exemplo de valor percentual:

{
  "transactionCode": "Q-53817",
  "priceType": 2,
  "nominalValueQuotation": null,
  "percentageValueQuotation": 1.6,
  "date": "2023-07-21T14:27:45.1177642-03:00",
  "type": "Price Quotation"
}

-----------------------------------------------------------------------

**Exemplo de valor nominal:
{
  "transactionCode": "Q-53778",
  "priceType": 1,
  "nominalValueQuotation": [
    {
      "ValorFaixa": 0,
      "LimiteInferior": 1,
      "LimiteSuperior": 1001
    },
    {
      "ValorFaixa": 0,
      "LimiteInferior": 1001,
      "LimiteSuperior": 5001
    },
    {
      "ValorFaixa": 0,
      "LimiteInferior": 5001,
      "LimiteSuperior": 10001
    },
    {
      "ValorFaixa": 0,
      "LimiteInferior": 10001,
      "LimiteSuperior": 30001
    },
    {
      "ValorFaixa": 0,
      "LimiteInferior": 30001,
      "LimiteSuperior": 0
    }
  ],
  "percentageValueQuotation": null,
  "date": "2023-07-19T14:07:10.7091745-03:00",
  "type": "Price Quotation"
}

Retorno de entidade assíncrona

Requisição
POST (urlWebhook configurada pelo cliente)REQUEST HEADER
Content-Type: application/json
Accept: application/json

REQUEST BODY

{
  "clientId": "testclient-1689354931527",
  "date": "2023-07-14T14:19:13.2000685-03:00",
  "type": "Create Entity"
}