Campanhas
  1. Listagem de Campanhas
Campanhas
  • CRMALL - Hosts
  • Campanhas
    • Autorização
      • Autorização
    • Documentos
      • Fluxo Geral - Integração para Envio e Processamento de Documentos
      • Envio de documentos por imagem
      • Envio de documentos por código eletrônico
      • Lista de documentos
      • Detalhes de um documento
    • Listagem de Campanhas
      • Listagem de Campanhas
        GET
    • Parâmetros da Campanha
      • Parâmetros da Campanha
    • Prizor SDK Web
      • Gerar URL
    • Transbordo de Notas
      • Transbordo de Notas
      • Recuperar mensagens da fila SQS
  1. Listagem de Campanhas

Listagem de Campanhas

GET
/v3/campaign
Retorna a lista de campanhas do parceiro.

Requisição

Authorization
Adicionar o parâmetro
Authorization
a Cabeçalhos
, cujo valor é concatenar o Token após o Bearer.
Exemplo:
Authorization: Bearer ********************
Parâmetros Query

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v3/campaign?isEnded&dataLimit&dataPage&participating&personDocumentNumber&latitude&longitude&partnerId&showTest&typeEnum&search&startDate&endDate&exclusiveFilters&ids'

Respostas

🟢200Success
application/json
Body

Exemplo
{
    "status": "success",
    "code": 200,
    "message": "''",
    "error": null,
    "dataCount": 10,
    "dataLimit": 10,
    "dataCurrentPage": 1,
    "dataLastPage": 1,
    "data": [
        {
            "id": 1234,
            "title": "Campanha Mães 2025",
            "hashtag": "maes2025",
            "campaignBanner": "ut minim adipisicing",
            "startDate": "2025-12-25T00:00:00-03:00",
            "endDate": "2025-12-30T00:00:00-03:00",
            "partnerId": 1234,
            "partnerName": "Parceiro Ltda",
            "partnerCity": "Maringá",
            "partnerState": "PR",
            "partnerLatitude": "-22.98495",
            "partnerLongitude": "-47.040916",
            "partnerLogo": "https://avatars.githubusercontent.com/u/77899800",
            "distance": "reprehenderit in veniam velit",
            "participating": false,
            "sentInvoice": "sit nisi Duis sunt",
            "ended": false,
            "isCampaignTest": false,
            "typeEnum": 77,
            "type": [
                "coupom",
                "sealed",
                "coupom"
            ],
            "inputTypesEnum": 3,
            "prizorGreenButton": false,
            "exclusiveFilters": [
                "dolore do fugiat eu officia",
                "in commodo"
            ],
            "prizorAppCameraEnabled": true,
            "crmall": {
                "url": "https://crmall4c.crmall.com/api",
                "credentials": "H4gLtHQN0Foo5SYbUwlhFOOzIHPOEuyTGcq5hIBfoojj5RT68Wkr",
                "underMaintenance": false
            },
            "baseUnica": {
                "url": "https://able-rubric.com/",
                "credentials": "commodo aute magna tempor dolor"
            },
            "inputTypes": [
                "nfe",
                "nfe",
                "token"
            ],
            "prizorKioskUnlockByTouch": "fullService",
            "prizorKioskUnlockByQRCode": "disabled"
        },
        {
            "id": 1234,
            "title": "Campanha Mães 2025",
            "hashtag": "maes2025",
            "campaignBanner": "ea",
            "startDate": "2025-12-25T00:00:00-03:00",
            "endDate": "2025-12-30T00:00:00-03:00",
            "partnerId": 1234,
            "partnerName": "Parceiro Ltda",
            "partnerCity": "Maringá",
            "partnerState": "PR",
            "partnerLatitude": "-22.98495",
            "partnerLongitude": "-47.040916",
            "partnerLogo": "https://avatars.githubusercontent.com/u/56928421",
            "distance": "incididunt eu",
            "participating": true,
            "sentInvoice": null,
            "ended": true,
            "isCampaignTest": true,
            "typeEnum": 19,
            "type": [
                "unique_bid",
                "prizeGiving",
                "hint"
            ],
            "inputTypesEnum": 92,
            "prizorGreenButton": true,
            "exclusiveFilters": [
                "aute ipsum velit",
                "minim ex"
            ],
            "prizorAppCameraEnabled": false,
            "crmall": {
                "url": "https://crmall4c.crmall.com/api",
                "credentials": "H4gLtHQN0Foo5SYbUwlhFOOzIHPOEuyTGcq5hIBfoojj5RT68Wkr",
                "underMaintenance": true
            },
            "baseUnica": {
                "url": "https://quarrelsome-someplace.us/",
                "credentials": "mollit"
            },
            "inputTypes": [
                "token"
            ],
            "prizorKioskUnlockByTouch": "fullService",
            "prizorKioskUnlockByQRCode": "enabled"
        }
    ]
}
Modificado em 2025-04-04 16:40:04
Página anterior
Detalhes de um documento
Próxima página
Parâmetros da Campanha
Built with