Exportar pesquisa em CSV

Os dados públicos da promoção comercial podem ser exportados no formato aberto CSV, o que permite uma maior compatibilidade com sistemas de carga automática de dados. Isso significa que os usuários podem facilmente importar esses dados para seus próprios sistemas, facilitando a integração e o uso dos dados em suas próprias aplicações.

Endereço de acesso:

GET /v1/promocao-comercial/export/csv

Exemplos de resquisição

Curl

    $ curl https://api.scpc.estaleiro.serpro.gov.br/v1/promocao-comercial/export/csv?anoPromocao=0000

Python

    import requests
    URL = 'https://api.scpc.estaleiro.serpro.gov.br/v1/promocao-comercial/export/csv?anoPromocao=0000'
    response = requests.get(URL)
    print(response.content)

Parâmetros de entrada

Campo Tipo Tamanho Obrigatório? Observação
anoPromocao inteiro 4 Sim
uf texto 2 Unidade federativa do Brasil. Somente promoções nesta abrangência serão consultadas.
cnpjMandatario texto 14 informar o CNPJ apenas com números e letras, sem separadores.
nomeMandatario texto 300 Informar nome do mandatário, ou trecho dele, para ser pesquisado. Também busca no nome dos aderentes
modalidade texto 50 Informar o tipo de promoção, que pode ser Concurso, Assemelhado a Concurso, Sorteio, Assemelhado a Sorteio, Vale-Brinde e Assemelhado a Vale-Brinde.
numeroCertificado texto 20 Número do certificado da promoção. Cada promoção, ao ser autorizada, recebe um número do certificado que é a identidade da promoção.
nomePromocao texto 200 Nome da promoção, ou trecho dele, que deseja ser procurado

Retorno

O Retorno da API será um arquivo no formato CSV contendo os seguintes campos:

Campo Tipo Tamanho Observação
sequencia Inteiro 3 Agrupamento de promoções no arquivo em questão
numero_promocao Texto 10 Número da promoção composto de ano <4 dígitos> e sequencial <5 dígitos>, no formato /.
nome_promocao Texto 250 Nome da promoção comercial.
modalidade Texto 50 Indica a modalidade da promoção comercial, que pode ser Concurso, Assemelhado a Concurso, Sorteio, Assemelhado a Sorteio, Vale-Brinde e Assemelhado a Vale-Brinde
certificado_autorizacao Texto 12 Número do certificado de autorização.
codigo_autenticidade Texto 60 Código de autenticação da promoção comercial.
situacao Texto 30
data_inicio Data 10 Data de início da validade da promoção comercial.
data_fim Data 10 Data de encerramento da promoção comercial.
quantidade_total_premios Inteiro 10 Quantidade de prêmios distribuídos na promoção somadas todas as apurações ou distribuição de brindes.
valor_promocao Decimal 10,2 Valor total dos prêmios distribuídos na promoção comercial.
quantidade_series Inteiro 10 Quando aplicával, indica a quantidade de séries da promoção comercial.
abrangencia Texto 100 Indica os estados de abrangência da promoção comercial.*
cnpj_mandatario Texto 14 CNPJ do mandatário sem formatação.
nome_mandatario Texto 250
endereco_mandatario Texto 250
numero_mandatario Texto 10 Número do endereço do mandatário, podendo conter letras.
complemento_mandatario Texto 400
bairro_mandatario Texto 400
municipio_mandatario Texto 250
uf_mandatario Texto 2 Indica a sigla do estado segundo o IBGE.
cep_mandatario Inteiro 8 CEP do mandatário sem formatação.
local_da_apuracao Texto 400 Indica o local da apuração, composto por Descrição - Logradouro. **
complemento_apuracao Texto 400
numero_apuracao Texto 10
bairro_apuracao Texto 250
municipio_apuracao Texto 250
uf_apuracao Texto 2 Indica a sigla do estado segundo o IBGE.
cep_apuracao Inteiro 8 CEP sem formatação.
inicio_apuracao Data 10 Indica a data de início da apuração, quando aplicável.
fim_apuracao Data 10 Indica a data fim da apuração. Indica a data do sorteio para as promoções deste tipo.
inicio_participacao Data 10 Data de início da participação para a apuração em questão.
fim_participacao Data 10 Data final da participação na apuração em questão.
descricao_premio Texto 4000 Descrição do prêmio da apuração. Nas promoções da modalidade Vale-Brinde e Assemelhado a Vale-Brinde, o prêmio é o brinde a ser distribuído.
quantidade_premio Inteiro 10
valor_premio Decimal 10,2 Valor unitário dos prêmios distribuídos.
ordem_premio Inteiro 10 Ordem sequencial de distribuição dos prêmios.
  • Se a promoção valer nacionalmentel, o valor do campo será BR.
    Se a promoção valer para mais de um estado, estes serão separados por vírgula.

** Promoções do tipo Vale-Brinde e Assemelhado a Vale-Brinde não possuem apuração. Nestes casos, o campo local_apuração trará o tipo de promoção comercial.