# API - Ecommerce # Introdução # Objetivo A API de Vendas tem por objetivo retornar as regras tributárias aprovadas diretamente do Cockpit no leiaute do Mercado Livre. # Acesso # Como acessar a API **Comunicação:** REST/JSON **Listagem do Endpoint que contempla o manual da API de Vendas**

Versão	Método	URL Endpoint
v1	POST	http://wscockpit.systax.com.br/ api/api/SalesRules

# Modelo da Chamada { "info": { "\_postman\_id": "662e03ef-ae0a-4705-a1fe-0aabdb891f34", "name": "API Vendas.v1", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", "\_exporter\_id": "21298242" }, "item": \[ { "name": "Teste", "request": { "method": "POST", "header": \[\], "body": { "mode": "raw", "raw": "{\\r\\n \\"username\\": \\"\\",//Login - Campo Obrigadório\\r\\n \\"password\\": \\"\\",//Senha - Campo Obrigadório\\r\\n \\"NCM\\": \\"\\", //NCM do Material - Campo Obrigadório\\r\\n \\"mat\_origin\\": \\"\\", //Origem da mercadora - campo Obrigadório\\r\\n \\"cest\\":\\"\\", //Código CEST - Campo opcional \\r\\n \\"page\\": \\"\\" //Página\\r\\n}", "options": { "raw": { "language": "json" } } }, "url": "http://wscockpit.systax.com.br/api/api/SalesRules" }, "response": \[\] } \] } # Autenticação # Nova Página # Como autenticar uma chamada A autenticação da API é feita pelo método Basic Auth utilizando credenciais de usuário e senha fornecidos pela Systax. # Estrutura de Dados da Chamada # Detalhamento dos dados da chamada A estrutura de dados da chamada é a seguinte:

TAG	DESCRIÇÃO	OBRIGATÓRIO
username	Login do Usuário	Sim
password	Senha do Usuário	Sim
NCM	NCM da Regra	Não
mat\_origin	Origem do Material	Não
cest	Código CEST	Não
page	Indica Paginação	Não

# Estrutura dos Dados do Retorno # Nova Página # Dados do Retorno - Cabeçalho

TAG	DESCRIÇÃO	TIPO
actual\_page	Página visualizada	Number
total\_pages	Quantidade de páginas retornadas para a pesquisa	Number
page\_limit	Limite de até 100 regras por página	Number
total\_rules	Quantas regras foram localizadas	Number
cest	Código Cest	Number (7 dígitos) Exemplo: 0100100
description\_list	Lista de descrição
id	Identificação única de cada item, a mesma informada em cada item na chamada	string
description	Descrição do produto	string
pointer	Deverá ser preservado pelo cliente e enviado na próxima chamada caso deseje receber somente informações novas. Ignorando essa informação, todo o conteúdo será reenviado. Ponteiro de atualização no formato: ano + mês + dia + hora+ minuto + segundo	integer
transactions	Informa se é contribuinte ou não contribuinte
operations	Lista de operações que compõe a transação
customer\_type	Identifica o tipo do comprador: Opções: >> taxpayer: Identifica um destinatário como contribuinte. >> non\_taxpayer: Identifica um destinatário como não contribuinte.	string
origin	UF de origem do produto. Indicar a sigla da UF	string
messagens	/
rules	Lista de regras tributárias que configuram a operação
value	Lista de valores das regras tributárias que configuram a operação
cst	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
cenq	Código de Enquadramento	inteiro
ppis	Alíquota em % (ex: 5.00)	decimal
pcofins	Alíquota em % (ex: 10.00)	decimal
destinations	Lista das regra tributárias que configuram a operação do destinatário da operação

# ICMS - CST 00

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbc	Modalidade da base de cálculo, considerando: 0 - margem de Valor Agregado (%) 1 - pauta (valor) 2 - preço tabelado máx. (valor) 3 - valor da operação	inteiro
pfcpufdest	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF destino	decimal
picmsufdest	Alíquota da UF\_destino (sem a inclusão do Fundo de Combate à Pobreza - FCP)	decimal
pfcp	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF destino	decimal
predbcdest	Redução da base de cálculo no ICMS na UF destino	decimal

# ICMS - CST 10

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbcst	Modalidade da base de cálculo do ICMS ST, considerando: 0 - pauta, preço tabelado ou máximo sugerido 1 - lista negativa (valor) 2 - lista positiva (valor) 3 - lista neutra (valor) 4 - margem valor agregado (%)	inteiro
pmvast	O percentual da margem do valor agregado (pMVAST) deve ser preenchido sempre que a modBCST for igual à 4 = MVA	decimal
predbcst	Percentual de redução de base de cálculo retido do ICMS ST	decimal
picmsst	Alíquota do imposto do ICMS ST	decimal
pfcpst	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP)

# ICMS - CST 20

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbc	Modalidade da base de cálculo, considerando: 0 - margem de Valor Agregado (%) 1 - pauta (valor) 2 - preço tabelado máx. (valor) 3 - valor da operação	inteiro
predbc	Percentual de redução da base de cálculo	decimal
pfcpufdest	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF destino	decimal
picmsufdest	Alíquota da UF de destino (sem a inclusão do Fundo de Combate à Pobreza - FCP)	decimal
modtdesicms	Campo destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Obs.: Informações separadas por ";", caso haja a combinação de mais de uma informação diferente	inteiro
pfcp	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino	string
cbenef	Código de benefícios fiscais	string
predbcdest	Percentual de redução de base de cálculo	decimal

# ICMS - CST 30

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbcst	Modalidade da base de cálculo do ICMS ST, considerando: 0 - pauta, preço tabelado ou máximo sugerido 1 - lista negativa (valor) 2 - lista positiva (valor) 3 - lista neutra (valor) 4 - margem valor agregado (%)	inteiro
pmvast	O percentual da margem do valor agregado (pMVAST) deve ser preenchido sempre que a modBCST for igual à 4 = MVA	decimal
predbcst	Percentual de redução de base de cálculo retido do ICMS ST	decimal
picmsst	Alíquota do imposto do ICMS ST	decimal
motdesicms	Campo destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Obs.: Informações separadas por ";", caso haja a combinação de mais de uma informação diferente	inteiro
pfcpst	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP)	decimal
cbenef	Código de benefícios fiscais	string

# ICMS - CST 40 e 50

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
motdesicms	Campo destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Obs.: Informações separadas por ";", caso haja a combinação de mais de uma informação diferente	inteiro
pfcpufdest	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF destino	decimal
picmsufdest	Alíquota da UF\_destino (sem a inclusão do Fundo de Combate à Pobreza - FCP)	decimal
predbcdest	Percentual de redução de base de cálculo do ICMS da UF de destino	decimal
cbenef	Código de benefícios fiscais	string

# ICMS - CST 41

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
motdesicms	Campo destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Obs.: Informações separadas por ";", caso haja a combinação de mais de uma informação diferente	inteiro
pfcpufdest	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF destino	decimal
picmsufdest	Alíquota da UF\_destino (sem a inclusão do Fundo de Combate à Pobreza - FCP)	decimal
predbcdest	Percentual de redução de base de cálculo do ICMS da UF de destino	decimal
cbenef	Código de benefícios fiscais	string

# ICMS - CST 51

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbc	Modalidade da base de cálculo, considerando: 0 - margem de Valor Agregado (%) 1 - pauta (valor) 2 - preço tabelado máx. (valor) 3 - valor da operação	inteiro
predbc	Percentual de redução de base de cálculo	decimal
pfcp	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino	decimal

# ICMS - CST 60

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
pfcpufdest	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF destino	decimal
picmsufdest	Alíquota da UF\_destino (sem a inclusão do Fundo de Combate à Pobreza - FCP)	decimal
predbcdest	Redução da base de cálculo no ICMS na UF destino	decimal

# ICMS - CST 70

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
cst	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbc	Modalidade da base de cálculo do ICMS ST, considerando: 0 - margem valor agregado (%) 1 - pauta (valor) 2 - preço tabelado máx. (valor) 3 - valor da operação	inteiro
predbc	Percentual de redução da base de cálculo	decimal
modbcst	Modalidade da base de cálculo do ICMS ST, considerando: 0 - pauta, preço tabelado ou máximo sugerido 1 - lista negativa (valor) 2 - lista positiva (valor) 3 - lista neutra (valor) 4 - margem valor agregado (%)	inteiro
pmvast	O percentual da margem do valor agregado (pMVAST) dever ser preenchido sempre que a modBCST for igual à 4	decimal
predbcst	Percentual de redução de base de cálculo do ICMS ST	decimal
picmsst	Alíquota do imposto do ICMS ST	decimal
motdesicms	Campo destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Obs. Informações separadas por ";" caso haja a combinação de mais de uma informação diferente.	inteiro
pfcpst	Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP)	string
cbenef	Código de benefícios fiscais	string

# ICMS - CST 90

TAG	DESCRIÇÃO	TIPO
uf	UF de destino do produto. Indicar a sigla da UF	string
CST	Código de situação tributária (ex: 00, 10, 40, 60, etc); ou Código de situação da operação - Simples Nacional - CSOSN (ex: 101, 202, 300, etc)	string
modbc	Modalidade da base de cálculo do ICMS, considerando: 0 - margem valor agregado (%) 1 - pauta (valor) 2 - preço tabelado máx. (valor) 3 - valor da operação	inteiro
predbc	Percentual de redução da base de cálculo	decimal
modbcst	Modalidade de base de cálculo do ICMS ST, considerando: 0 - pauta, preço tabelado ou máximo sugerido 1 - lista negativa (valor) 2 - lista positiva (valor) 3 - lista neutra (valor) 4 - margem de valo agregado (%)
pmvast	O percentual da margem do valor agregado (pMVAST) dever ser preenchido sempre que a modBCST for igual à 4	decimal
predbcst	Percentual de redução de base de cálculo do ICMS ST	decimal
picmsst	Alíquota do imposto do ICMS ST	decimal
motdesicms	Campo destinado ao retorno de uma ou mais informações de interesse do usuário para as quais não haja campo específico no leiaute. Obs. Informações separadas por ";" caso haja a combinação de mais de uma informação diferente.	inteiro