Recuperar mensagens da fila SQS

A requisição deve ser feita para o AWS SQS para recuperar as mensagens. Abaixo exemplo da resposta e payload contido no Body da mensagem.

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Este exemplo refere-se ao campo Body da mensagem recuperada do AWS SQS. Consulte as instruções "Transbordo de Notas" nesta documentação e também a documentação oficial do AWS SQS.

Body

campaign

object

requerido

Informações da campanha

campaignId

string

requerido

ID da campanha

Exemplo:

9876

campaignIdIndirect

string | null

deprecated

ID da campanha indireta

Exemplo:

1234

campaignName

string

requerido

Nome da campanha

Exemplo:

Dia das Mães

invoice

object

requerido

Informações da nota

personDocumentNumber

string

requerido

CPF do cadastro

Exemplo:

99988877766

ownerDocumentNumber

string | null

requerido

CPF da nota

Exemplo:

11122233344

situationDocumentNumber

enum<string>

requerido

ID da situação do documento

Valores permitidos:

123

situationDocumentNumberEnum

enum<string>

requerido

Situação do CPF na nota

Valores permitidos:

normalmascaradonão informado

storeDocument

string

requerido

CNPJ da da loja

Exemplo:

05.887.876/0001-15

storeCorporateName

string | null

requerido

Razão social da loja

Exemplo:

Loja Ldta

number

string

requerido

Número da nota

Exemplo:

112233

value

string

requerido

Valor da nota considerando produtos removidos

Exemplo:

120.89

totalValue

string

requerido

Valor bruto da nota

Exemplo:

130.89

paymentId

string | null

deprecated

ID do tipo de pagamento

purchaseDate

string

requerido

Data da compra

Exemplo:

25/12/2024

infoDocument

string | null

requerido

Apenas para documentos inválidos para a campanha. Mensagem informando o motivo da invalidação

Exemplo:

Não é um documento fiscal válido

partnerInternalCode

string | null

requerido

Código interno do parceiro

Exemplo:

abc123XYZ987

documentSubType

enum<string> | enum<null>

requerido

ID do subtipo do documento

Valores permitidos:

1379

documentSubTypeEnum

enum<string> | enum<null>

requerido

Nome do subtipo do documento

Valores permitidos:

CUPOM FISCALNOTA FISCALOUTRORECIBO ESCRITO À CANETA

accessKey

string

requerido

Chave 44 dígitos da nota eletrônica

Exemplo:

35990635097789900158590007400670099953195948

searchCode

string | null

requerido

QRCode da nota eletrônica

Exemplo:

CFe35990635097789900158590007400670099953195948|20210618180831|366|13015510827|qQbIWRUFgw91ejLeSIrMds0wSDWgkQPDVSGUgY9+YcaycKj0rvBZCnEKECZHs6S/2Ct+KrcBen39B369jl98dqfkXYLS97BSmuMyqM+yxYT5Bb++CA4C/bsrKBvu3CfDzHBFooPeLhkyQEQ2i/JY0Oav0QbPH518gw4teKHDyFs0s7B0UkUmyTAprmkrLOcqzrgj1XMr2814OCsnrMMqtPzXBtnLPEPJrFySFOOmihiiahbDcjZ4LIy6bCVwDp7GjSfpaGG5T/NkrT8YPjZsrc/iralsfOOKZIp+h9hFIV0OCCLUFoMFCLj3uzk6KkaxYvFooVevUthWELyDLN2pZQ=="

sellerCode

string | null

requerido

Código do vendedor (incentivo ao vendedor)

Exemplo:

1234

items

array [object {7}]

requerido

Array com os itens da nota

reused

object | null

requerido

Informações de reaproveitamento de documento

electronicInvoicePaymentTypes

array [object {3}]

requerido

Informações das formas de pagamento da nota eletrônica

invoiceId

string

requerido

Número da nota fiscal

Exemplo:

987654

documentType

enum<string>

Ver o item documentTypeEnum

requerido

ID do tipo de documento como a nota processada

Valores permitidos:

148

documentTypeEnum

enum<string>

requerido

Nome do tipo de documento como a nota foi processada

Valores permitidos:

receiptnfenfce

status

enum<string>

requerido

ID interno - Status do documento

Valores permitidos:

1248

statusEnum

enum<string>

requerido

Interno - Status do documento

Valores permitidos:

INVALIDPROCESSINGVERIFIEDPROCESSED

storeNameFantasy

string | null

requerido

Nome fantasia do fornecedor

Exemplo:

Loja

paymentTypeEnum

string | null

deprecated

Nome do tipo de pagamento

dateinclusion

string

requerido

Data de recebimento do documento

Exemplo:

2025-02-13 11:58:48

image

object

requerido

Informações da imagem

imageId

string

requerido

ID interno da imagem

Exemplo:

418715

imageUuid

string

requerido

UUID interno da imagem

Exemplo:

da8df00592d704d09foof3c587c511ac

path_s3

string

requerido

Path S3 da imagem

Exemplo:

image/3/418715.jpg

link

string

requerido

Link

Exemplo:

https://crmall-dev-transbordo-notas.s3.sa-east-1.amazonaws.com/image/3/418715.jpg

group

object

requerido

Informações sobre o grupo de transcrição

groupId

string

requerido

ID do grupo de transcrição

Exemplo:

987

partner

object

requerido

partnerId

string

requerido

ID interno do parceiro

Exemplo:

1234

partnerDocument

string

requerido

CNPJ do parceiro

Exemplo:

05887876000115

partnerName

string

requerido

Nome do parceiro

Exemplo:

Parceiro Crmall

Exemplo

{
    "campaign": {
        "campaignId": "9876",
        "campaignIdIndirect": "1234",
        "campaignName": "Dia das Mães"
    },
    "invoice": {
        "personDocumentNumber": "99988877766",
        "ownerDocumentNumber": "11122233344",
        "situationDocumentNumber": "1",
        "situationDocumentNumberEnum": "normal",
        "storeDocument": "05.887.876/0001-15",
        "storeCorporateName": "Loja Ldta",
        "number": "112233",
        "value": "120.89",
        "totalValue": "130.89",
        "paymentId": "string",
        "purchaseDate": "25/12/2024",
        "infoDocument": "Não é um documento fiscal válido",
        "partnerInternalCode": "abc123XYZ987",
        "documentSubType": "1",
        "documentSubTypeEnum": "CUPOM FISCAL",
        "accessKey": "35990635097789900158590007400670099953195948",
        "searchCode": "CFe35990635097789900158590007400670099953195948|20210618180831|366|13015510827|qQbIWRUFgw91ejLeSIrMds0wSDWgkQPDVSGUgY9+YcaycKj0rvBZCnEKECZHs6S/2Ct+KrcBen39B369jl98dqfkXYLS97BSmuMyqM+yxYT5Bb++CA4C/bsrKBvu3CfDzHBFooPeLhkyQEQ2i/JY0Oav0QbPH518gw4teKHDyFs0s7B0UkUmyTAprmkrLOcqzrgj1XMr2814OCsnrMMqtPzXBtnLPEPJrFySFOOmihiiahbDcjZ4LIy6bCVwDp7GjSfpaGG5T/NkrT8YPjZsrc/iralsfOOKZIp+h9hFIV0OCCLUFoMFCLj3uzk6KkaxYvFooVevUthWELyDLN2pZQ==\"",
        "sellerCode": "1234",
        "items": [
            {
                "code": "000000000020038987",
                "ncm": "85167100",
                "description": "MAQUINA TRES S27 POP PLUS PRETA127V",
                "count": "23",
                "unitType": "PC",
                "unitPrice": "100",
                "totalPrice": "100"
            }
        ],
        "reused": {
            "campaignId": "1234",
            "campaignName": "Mães 2025"
        },
        "electronicInvoicePaymentTypes": [
            {
                "type": "Crédito Loja",
                "paid": "10.23",
                "removed": "0"
            }
        ],
        "invoiceId": "987654",
        "documentType": "1",
        "documentTypeEnum": "receipt",
        "status": "1",
        "statusEnum": "INVALID",
        "storeNameFantasy": "Loja",
        "paymentTypeEnum": "string",
        "dateinclusion": "2025-02-13 11:58:48"
    },
    "image": {
        "imageId": "418715",
        "imageUuid": "da8df00592d704d09foof3c587c511ac",
        "path_s3": "image/3/418715.jpg",
        "link": "https://crmall-dev-transbordo-notas.s3.sa-east-1.amazonaws.com/image/3/418715.jpg"
    },
    "group": {
        "groupId": "987"
    },
    "partner": {
        "partnerId": "1234",
        "partnerDocument": "05887876000115",
        "partnerName": "Parceiro Crmall"
    }
}