Campanhas
  1. Documentos
Campanhas
  • CRMALL - Hosts
  • Campanhas
    • Autorização
      • Autorização
    • Documentos
      • Fluxo Geral - Integração para Envio e Processamento de Documentos
      • Envio de documentos por imagem
        POST
      • Envio de documentos por código eletrônico
        POST
      • Lista de documentos
        GET
      • Detalhes de um documento
        GET
    • Listagem de Campanhas
      • Listagem de Campanhas
    • 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. Documentos

Detalhes de um documento

GET
/v3/document/details/{documentUuid}
Obter detalhes de um documento.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path
documentUuid
string 
requerido
UUID do documento
Exemplo:
2292431dfoo0e47dc199c1b32cdfoof2

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/details/2292431dfoo0e47dc199c1b32cdfoof2'

Respostas

🟢200Success
application/json
Body
status
string 
requerido
code
string 
requerido
message
string 
requerido
error
string 
requerido
data
object 
requerido
id
string 
requerido
partnerId
string  | null 
requerido
internalCode
string  | null 
requerido
isCancelled
boolean 
requerido
storeDocument
string 
requerido
storeName
string 
requerido
purchaseDate
string 
requerido
value
number 
requerido
totalValue
number 
requerido
message
string 
requerido
created
string 
requerido
statusEnum
enum<string> 
requerido
Valores permitidos:
124816326412810242048
status
string 
Verifique "statusEnum"
requerido
documentTypeEnum
integer 
requerido
documentType
string 
requerido
paymentTypeId
string  | null 
requerido
paymentType
string  | null 
requerido
seller
string  | null 
requerido
image
string  | null 
requerido
imagePrizor
string  | null 
requerido
campaignStatus
string 
requerido
Exemplo
{
    "status": "success",
    "code": 200,
    "message": "",
    "error": null,
    "data": {
        "id": "2292431dfoo0e47dc199c1b32cdfoof2",
        "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": "Loja não encontrada",
        "created": "2025-02-12T16:24:41-03:00",
        "statusEnum": 64,
        "status": "quarantine",
        "documentTypeEnum": 4,
        "documentType": "nfe",
        "paymentTypeId": null,
        "paymentType": null,
        "seller": null,
        "image": null,
        "imagePrizor": "https://campanhas-qa.crmall.com/api/v3/document/image-prizor/2292431dfoo0e47dc199c1b32cdfoof2",
        "campaignStatus": []
    }
}
Modificado em 2025-05-27 14:54:23
Página anterior
Lista de documentos
Próxima página
Listagem de Campanhas
Built with