- CRMALL - Hosts
- Campanhas
- Autorização
- Documentos
- Listagem de Campanhas
- Parâmetros da Campanha
- Prizor SDK Web
- Transbordo de Notas
Lista de documentos
GET
/v3/document
campanhaslista documentos
Requisição
Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.Exemplo:
Authorization: Bearer ********************Parâmetros Query
campaignId
integer
requerido
Exemplo:
9876
personDocumentNumber
string
requerido
Exemplo:
11122233399
Exemplos de Requisiçã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/document?campaignId=9876&personDocumentNumber=11122233399'Respostas
🟢200Success
application/json
Body
status
string
requerido
code
integer
requerido
message
string
requerido
error
string | null
requerido
data
array [object {16}]
requerido
id
string
requerido
partnerId
string | null
requerido
internalCode
string | null
requerido
isCancelled
boolean
requerido
storeDocument
string
requerido
storeName
string
requerido
number
string
requerido
purchaseDate
string
requerido
value
number
requerido
totalValue
number
requerido
message
string
requerido
created
string
requerido
statusEnum
enum<integer>
requerido
Valores permitidos:
124816326412810242048
status
string
Verifique "statusEnum"
documentTypeEnum
enum<integer>
requerido
Valores permitidos:
148
documentType
string
Verifique "documentTypeEnum"
Exemplo
{
"status": "success",
"code": 200,
"message": "",
"error": null,
"data": [
{
"id": "87foo31dfb99e47dc186c1b32fooc4f2",
"partnerId": null,
"internalCode": null,
"isCancelled": false,
"storeDocument": "05887887000187",
"storeName": "Loja S.A",
"number": "1174118",
"purchaseDate": "2025-01-02T00:00:00-03:00",
"value": 428.89,
"totalValue": 428.89,
"message": "",
"created": "2025-02-12T16:24:41-03:00",
"statusEnum": 8,
"status": "processing",
"documentTypeEnum": 1,
"documentType": "receipt"
},
{
"id": "87foo31dfb99e47dc186c1b32fooc4f2",
"partnerId": null,
"internalCode": null,
"isCancelled": false,
"storeDocument": "05887887000187",
"storeName": "Loja S.A",
"number": "1174118",
"purchaseDate": "2025-01-02T00:00:00-03:00",
"value": 428.89,
"totalValue": 428.89,
"message": "",
"created": "2025-02-12T16:24:41-03:00",
"statusEnum": 64,
"status": "quarantine",
"documentTypeEnum": 8,
"documentType": "nfce"
},
{
"id": "87foo31dfb99e47dc186c1b32fooc4f2",
"partnerId": null,
"internalCode": null,
"isCancelled": false,
"storeDocument": "05887887000187",
"storeName": "Loja S.A",
"number": "1174118",
"purchaseDate": "2025-01-02T00:00:00-03:00",
"value": 428.89,
"totalValue": 428.89,
"message": "Documento ilegível",
"created": "2025-02-12T16:24:41-03:00",
"statusEnum": 1,
"status": "invalid",
"documentTypeEnum": 1,
"documentType": "receipt"
}
]
}Modificado em 2025-04-22 19:47:38