Ciclos

GET https://www.sellerpay.com.br/api/v1/ciclos/detalhes/{idCiclo}/

Retorna os detalhes do ciclo

🔒 Limite de requisição: 20 requisições por minuto.

Descrição

Retorna os detalhes dos ciclos:

Os repasses são divididos em três partes:
- pedidosTitulos: uma lista de repasses ou retenções que informam o título e a parcela associada.
- pedidosEventos: uma lista de repasses ou retenções no pedido que não estão vinculados a parcelas específicas, como frete, rebate e taxas adicionais.
- eventos: uma lista de repasses ou retenções que não estão vinculados a pedidos específicos, como impostos.

Exemplo de requisição: https://www.sellerpay.com.br/api/v1/ciclos/detalhes/2

Parâmetro "camposOcultos":
Você pode utilizar o parâmetro camposOcultos para remover campos específicos do JSON, resultando em um JSON menor, com menos megabits.
Exemplo: https://www.sellerpay.com.br/api/v1/ciclos/detalhes/2/?camposOcultos=chaveNFe,pedidoComplementar,numeroNFe,clientecpfCnpj
Campos que podem ser removidos: pedidoERP, pedidoCanal, pedidoComplementar, numeroNFe, serieNFe, chaveNFe, filialFatura, cpfCnpj, cliente.cpfCnpj
Esta funcionalidade está disponível apenas para "pedidosTitulos" e "pedidosEventos". Valor padrão caso não informado é true.

Parâmetro "agruparEventos":
Você pode usar o parâmetro agruparEventos com os valores true ou false para controlar a forma como os retornos dos eventos são apresentados, agrupados ou não.
Exemplo: https://www.sellerpay.com.br/api/v1/ciclos/detalhes/2/?agruparEventos=true
Esta funcionalidade está disponível apenas para "eventos".

Parâmetro "retornoUnico":
Se você deseja obter apenas um dos 3 campos disponíveis ("pedidosTitulos", "pedidosEventos" ou "eventos"), basta especificá-lo no parâmetro "retornoUnico". Se nenhum campo for especificado, o sistema retornará todos os 3 campos por padrão.
Fazer chamadas separadas pode ser benéfico em cenários com muitos registros, pois melhora o desempenho de retorno e facilita o processamento.
Exemplo: https://www.sellerpay.com.br/api/v1/ciclos/detalhes/2/?retornoUnico=pedidosTitulos

Parâmetros de Entrada

Campo	Descrição	Tipo	Obrigatório
agruparEventos	Controla se os retornos dos eventos devem ser agrupados (true) ou não agrupados (false).	string	não
camposOcultos	Lista de campos específicos do JSON que devem ser removidos, separados por vírgula.	string	não
retornoUnico	Retorna apenas um dos seguintes campos: "pedidosTitulos", "pedidosEventos" ou "eventos".	string	não

Resposta de Sucesso

200 OK

{
    "pedidosTitulos": [
        {
            "pedido": "",
            "pedidoERP": "",
            "pedidoCanal": "",
            "pedidoComplementar": "",
            "numeroNFe": 0,
            "serieNFe": 2,
            "chaveNFe": "",
            "filialFatura": "",
            "cpfCnpj": "",
            "clientecpfCnpj": "",
            "situacao": {
                "titulo": "",
                "pedido": "",
                "canal": ""
            },
            "titulos": [
                {
                    "codigoControle": "",
                    "qtTotalParcela": 0,
                    "valorTotal": 0,
                    "parcelas": [
                        {
                            "numero": 0,
                            "valorParcela": 0,
                            "situacao": "",
                            "eventos": [
                                {
                                    "evento": "",
                                    "parcela": 0,
                                    "qtTotalParcela": 0,
                                    "valor": 0
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "pedidosEventos": [
        {
            "pedido": "",
            "pedidoERP": "",
            "pedidoCanal": "",
            "pedidoComplementar": "",
            "numeroNFe": 0,
            "serieNFe": 0,
            "chaveNFe": "",
            "filialFatura": "",
            "cpfCnpj": "",
            "clientecpfCnpj": "",
            "totalValor": 0,
            "eventos": [
                {
                    "evento": "",
                    "totalValor": 0
                }
            ]
        }
    ],
    "eventos": [
        {
            "totalValor": 0,
            "evento": "",
            "identificador": ""
        }
    ]
}

Dados de Resposta

Campo	Descrição	Tipo	Tamanho
pedidosTitulos	Informações detalhadas sobre o retorno da consulta	object
pedido	Seu número de pedido	string
pedidoERP	Número do pedido do ERP	string
pedidoCanal	Número do pedido ou identificação da entrega do canal. Este campo é utilizado para identificação no arquivo da conciliação do marketplace.	string
pedidoComplementar	Se acaso o canal possuir mais de um identificador.	string
numeroNFe	Número do da nota fiscal	integer
serieNFe	Número do serie da Nota fiscal	integer
chaveNFe	Chave da Nota fiscal eletrônica	string
filialFatura	Código da filial que emitiu a nota fiscal.	string
cpfCnpj	CNPJ da filial que emitiu a nota fiscal.td>	string
clientecpfCnpj	Número do documento do cliente	string
situacao	Situações	object
titulo	Situação do titulo no canal de vendas. pendente, pago, pago parcial, cancelado ou cancelado parcial	string
pedido	Situação do pedido na plataforma. aprovado, faturado, despachado, entregue, em devolução ou cancelado	numeric
canal	Situação do pedido no canal de vendas. aprovado, faturado, despachado, entregue ou cancelado	numeric
titulos	Lista de títulos	object
qtTotalParcela	Quantidade total de parcelas no titulo	integer
valorTotal	Valor total do titulo	numeric
parcelas	Lista de Parcelas	object
numero	Número sequencial da parcela	integer
valorParcela	Valor da parcela	numeric
situacao	Situação da Parcela: pendente, pago ou cancelado	string
eventos	Lista de eventos	object
evento	Descrição do Evento	string
parcela	Número da parcela (informação recebida do canal)	integer
codigoControle	Código do controle do titulo	string
qtTotalParcela	Quantidade total de parcelas (informação recebida do canal)	integer
valor	Valor do repasse	numeric
pedidosEventos	Informações detalhadas sobre o retorno da consulta	object
pedido	Seu número de pedido	string
pedidoERP	Número do pedido do ERP	string
pedidoCanal	Número do pedido ou identificação da entrega do canal. Este campo é utilizado para identificação no arquivo da conciliação do marketplace.	string
pedidoComplementar	Se acaso o canal possuir mais de um identificador.	string
numeroNFe	Número do da nota fiscal	integer
serieNFe	Número do serie da Nota fiscal	integer
chaveNFe	Chave da Nota fiscal eletrônica	string
filialFatura	Código da filial que emitiu a nota fiscal.	string
cpfCnpj	CNPJ da filial que emitiu a nota fiscal.	string
clientecpfCnpj	Número do documento do cliente	string
totalValor	Valor total dos Eventos. (repasse total)	string
eventos	Informações dos eventos	array
evento	Descrição do Evento	string
totalValor	Valor do repasse	numeric
eventos	Informações detalhadas sobre o retorno da consulta	object
totalValor	Valor do repasse.	numeric
evento	Descrição do Evento.	string	255
identificador	Código identificador do evento. Disponível apenas se o parâmetro eventosAgrupado for false	string	255

Resposta de Erro

400 Bad Request

{
    "mensagem": ""
}

Campo	Descrição	Tipo	Tamanho
mensagem	Mensagem de retorno. Exemplo: Json não informado Loja não ativa	string	255