Perfect Support

Vendas

Os parâmetros passados aqui servem para filtrar os dados recebidos como resposta

HEADERS :

Nome	Atributos
Accept	application/json
Content-Type	application/json
Authorization	Bearer "access_token"

POST

https://app.perfectpay.com.br/api/v1/sales/get

PARÂMETROS:

NOME	ATRIBUTOS	FORMATO	DESCRIÇÃO
start_date_sale	string	yyyy-mm-dd	Data inicial da venda
end_date_sale	string	yyyy-mm-dd	Data final da venda
start_date_approved	string	yyyy-mm-dd	Data inicial de aprovação da venda
end_date_approved	string	yyyy-mm-dd	Data final de aprovação da venda
sale_status	array	-	`1 => 'Pendente', 2 => 'Aprovado', 3 => 'Processando', 4 => 'Mediação', 5 => 'Rejeitado', 6 => 'Cancelado', 7 => 'Devolvido', 8 => 'Autorizado', 9 => 'Cobrado de volta', 10 => 'Completo', 11 => 'Erro de Checkout', 12 => 'Pré-checkout', 13 => 'Expirado', 16 => 'Revisão'`
transaction_token	string	-	Identificador da venda
page	int	-	Paginação do resultado

RESPOSTA 200 :

Nome	Formato	Descrição
product_code	String	Código do Produto
product_name	String	Nome do Produto
transaction_token	String	Identificador da venda
value	Decimal	Valor total da Venda
unit_value	Decimal	Valor unitário do Produto
shipping_value	Decimal	Valor do frete
plan.plan_name	String	Nome do Plano
plan.plan_code	String	Código do Plano
plan.quantity	Integer	Quantidade de produtos no plano
customer.full_name	String	Nome completo do cliente
customer.email	String	Email do cliente
customer.identification_type	String	Tipo de identificação do cliente: `1 => 'CPF', 2 => 'CNPJ', 3 => 'ESTRANGEIRO'`
customer.identification_number	String	Número do documento de identificação
customer.phone	String	Número de telefone do cliente
customer.zip_code	String	Código postal do cliente
customer.street_name	String	Nome da rua
customer.street_number	Integer	Número da rua
customer.complement	String	Complemento
customer.district	String	Bairro
customer.city	String	Cidade
customer.state	String	Estado
customer.country	String	País
commissions.affiliation_name	String	Nome do afiliado
commissions.affiliation_type	Integer	Tipo de Afiliado: `1 => 'Produtor', 2 => 'Co-Produtor', 3 => 'Gerente de Afiliados', 4 => 'Parceiro', 5 => 'Afiliado',`
commissions.commission	Decimal	Comissão
commissions.value	Decimal	Valor da comissão
commissions.commission_type	Integer	Tipo de comissão: `1 => 'R$', 2 => '%'`
total_invoices	String	Total de faturas
invoices.external_id	String	Código externo
invoices.logistic_id	String	Código da logística
invoices.fiscal_number	Integer	Número da nota fiscal
invoices.fiscal_access_key	String	Chave de acesso da nota fiscal
invoices.fiscal_pdf	String	URL do arquivo em PDF da nota fiscal
invoices.fiscal_xml	String	URL do arquivo em XML da nota fiscal
invoices.fiscal_status	String	Status da nota fiscal gravado pela logística
invoices.fiscal_date_emission	String	Data de emissão da nota fiscal
metadata.src	String	Src
metadata.utm_source	String	Utm source
metadata.utm_medium	String	Utm medium
metadata.utm_campaign	String	Utm campaign
metadata.utm_term	String	Utm term
metadata.utm_content	String	Utm content
metadata.utm_perfect	String	Utm perfect
sale_status	String	Status da venda: `'pending', 'approved', 'in_process', 'in_mediation', 'rejected', 'cancelled', 'refunded', 'authorized', 'charged_back', 'completed', 'checkout_error', 'precheckout', 'expired', 'cancelled_regenerated', 'in_review', 'pre_chargeback', 'pre_refunded',`
date_created	Date	Data da venda
date_approved	Date	Data de aprovação da venda
payment_type	Integer	Tipo de pagamento `1 => 'Cartão de crédito', 2 => 'Boleto', 3 => 'PayPal', 5 => 'Gratuito', 6 => 'Cartão de crédito - upsell', 7 => 'Pix',`
current_page	Integer	Página atual
current_items_count	Integer	Contagem dos itens atuais
total_pages	Integer	Total de páginas da pesquisa
total_items	Integer	Total de itens da pesquisa

SUCCESS-RESPONSE :

{
  "sales": {
    "data": [{
      "product_code": "PPBP2A04",
      "product_name": "Herus Caps",
      "transaction_token": "CPTFB5RR2MNGGF",
      "value": "385.00",
      "unit_value": "77.00",
      "shipping_amount": "0.00",
      "plan": [{
        "plan_name": "Herus Caps | 5 Potes",
        "plan_code": "UUTGG9Q9R",
        "quantity": 5
      }],
      "customer": [{
        "full_name": "Example Name",
        "email": "[email protected]",
        "identification_type": "CPF",
        "identification_number": "54645896548",
        "phone": "(55) 94548-4767",
        "zip_code": "34578-888",
        "street_name": "Rua Example",
        "street_number": null,
        "complement": null,
        "district": "Centro",
        "city": "Example City",
        "state": "RS",
        "country": "BR"
      }],
      "commissions": [{
        "affiliation_name": "Affiliate Example",
        "affiliation_type": 5,
        "value": 144.51,
        "commission": 40,
        "commission_type": 1
      }, {
        "affiliation_name": "Affiliate Example2",
        "affiliation_type": 1,
        "value": 216.77,
        "commission": 100,
        "commission_type": 1
      }],
      "metadata": {
        "src": null,
        "utm_source": "teste",
        "utm_medium": "medio",
        "utm_campaign": "campaign",
        "utm_term": null,
        "utm_content": null,
        "utm_perfect": null,
      },
      "total_invoices": 2,
      "invoices": [{
        "external_id": null,
        "logistic_id": null,
        "fiscal_number": 123,
        "fiscal_access_key": "456",
        "fiscal_pdf": "http:\/\/pdf",
        "fiscal_xml": "hhtp:\/\/xlm",
        "fiscal_status": "Autorizada",
        "fiscal_date_emission": "2019-05-02 00:00:00"
      }, {
        "external_id": null,
        "logistic_id": null,
        "fiscal_number": 123,
        "fiscal_access_key": "456",
        "fiscal_pdf": "http:\/\/pdf",
        "fiscal_xml": "hhtp:\/\/xlm",
        "fiscal_status": "Autorizada",
        "fiscal_date_emission": "2019-05-02 00:00:00"
      }],
      "sale_status": "approved",
      "payment_type": 1,
      "date_created": "2019-02-19 13:31:28",
      "date_approved": "2019-02-19 13:32:09"
    }],
    "current_page": 1,
    "current_items_count": 1,
    "total_pages": 1,
    "total_items": 1
  }
}

Essa página foi útil ? Sim ou Não

HEADERS :

PARÂMETROS:

RESPOSTA 200 :

Nome

Formato

Descrição

SUCCESS-RESPONSE :