Skip to main content
GET
cURL

Escopo

Status do Pedido

Dados do Cliente e Endereço

Importante: Os dados do cliente retornados dependem do nível de acesso do usuário:
O nível de acesso é determinado pelas configurações do produto vendido que pode ou não compartilhar as informações de contato do cliente com afiliados e coprodutores.
  • Com acesso total: Retorna todos os dados do cliente (nome, email, telefone, documento, etc.)
  • Sem acesso: Retorna apenas o nome do cliente
O mesmo se aplica aos dados de endereço do pedido, retornando null quando o usuário não tem acesso.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string<uuid>
required

Id do Pedido

Response

Corpo da resposta status 200

baseAmount
string<decimal>
required

Valor base do pedido antes de descontos e taxas

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
coupon
object
required

Cupom aplicado na compra

product
object
required

Produto adquirido na compra

paymentMethod
string
required

Método de pagamento utilizado na compra

createdAt
string<date-time>
required
read-only

Data e hora de criação

customer
object
required

Cliente que realizou a compra

address
object
required

Endereço do cliente

absorbInstallmentInterest
boolean
required
read-only

Indica se o produtor absorveu os juros de parcelamento

commissionedUsers
object[]
required
read-only

Usuários comissionados na compra

commissions
object[]
required
read-only

Detalhes das comissões associadas à compra

id
string

Identificador único do pedido no sistema

Maximum string length: 255
refId
string

Id curto de referência do pedido

Maximum string length: 255
status
enum<string>

Status atual do pedido

  • processing - Processando
  • authorized - Autorizado
  • paid - Pago
  • refund_requested - Reembolso solicitado
  • in_settlement - Em efetivação
  • acquirer_error - Erro na adquirente
  • refunded - Reembolsado
  • waiting_payment - Aguardando pagamento
  • refused - Recusado
  • blocked - Recusado
  • chargedback - Chargeback
  • canceled - Cancelado
  • in_protest - Em protesto
  • partially_paid - Parcialmente pago
  • prechargeback - Prechargeback
  • scheduled - Scheduled
  • retrying - Retrying
  • MED - Med
Available options:
processing,
authorized,
paid,
refund_requested,
in_settlement,
acquirer_error,
refunded,
waiting_payment,
refused,
blocked,
chargedback,
canceled,
in_protest,
partially_paid,
prechargeback,
scheduled,
retrying,
MED
type
enum<string>

Tipo do produto comprado no pedido

  • unique - Pagamento único
  • subscription - Assinatura recorrente
Available options:
unique,
subscription
offer_type
enum<string>

Tipo da oferta comprada no pedido

  • main - Principal
  • upsell - Upsell
  • downsell - Downsell
  • orderbump - Order Bump
Available options:
main,
upsell,
downsell,
orderbump
discount
string<decimal> | null

Valor do desconto aplicado no pedido

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
amount
string<decimal> | null

Valor total do pedido após descontos e taxas

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
couponCode
string | null

Código do cupom de desconto aplicado no pedido

Maximum string length: 255
reason
string | null

Motivo de recusa do pagamento

Maximum string length: 255
refund_reason
string | null

Descrição do motivo do reembolso do pedido

checkout
integer | null

Checkout onde a compra foi realizada

subscription
string | null

Assinatura associada ao pedido

subscription_period
integer | null

Período da assinatura que este pedido corresponde

Required range: -2147483648 <= x <= 2147483647
installments
integer

Número de parcelas que o valor foi dividido

Required range: -2147483648 <= x <= 2147483647
due_date
string<date-time> | null

Data e hora em que o pagamento será processado

paidAt
string<date-time> | null

Data e hora em que o pedido foi pago

releaseDate
string<date-time> | null

Data e hora estimada de liberação das comissões

refundedAt
string<date-time> | null

Data e hora em que o pedido foi reembolsado

refundRequestedAt
string<date-time> | null

Data e hora em que a solicitação de reembolso foi feita pelo cliente

refundReversalDeadlineAt
string<date-time> | null

Momento em que o reembolso será efetivado automaticamente se não houver cancelamento

chargedbackAt
string<date-time> | null

Data e hora que o chargeback foi realizado

canceledAt
string<date-time> | null

Data e hora de cancelamento do pedido

fees
string<decimal> | null

Valor total das taxas aplicadas ao pedido

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
additionalInstallmentInterest
string<decimal>

Valor adicional de juros de parcelamento cobrado do cliente, aumenta os ganhos do produtor

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
interest
string<decimal> | null

Valor total de juros de parcelamento cobrado

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
utm_source
string | null

Origem do tráfego (ex: google, instagram, newsletter)

Maximum string length: 255
utm_medium
string | null

Meio do tráfego (ex: cpc, email, social)

Maximum string length: 255
utm_campaign
string | null

Nome da campanha (ex: promocao_2023)

Maximum string length: 255
utm_term
string | null

Termo da campanha (ex: sapato+vermelho)

Maximum string length: 255
utm_content
string | null

Conteúdo da campanha (ex: banner_superior)

Maximum string length: 255
sck
string | null

Parâmetro personalizado, geralmente usado internamente para rastrear algo específico (ex: ID de clique, sessão, ou código de origem próprio)

Maximum string length: 255
checkoutUrl
string | null

URL do checkout onde o pedido foi realizado