CAcakto
orders

GET /public_api/orders/{id}/

Public API for managing orders, inherits from OrderRetrieveAPI and OrderListAPIView, customizes the schema generation and authentication/permission settings.

Request

Path parameters

idstring uuid required

Id do Pedido

Response

Corpo da resposta status 200

idstring

Identificador único do pedido no sistema

refIdstring

Id curto de referência do pedido

status'processing' | 'authorized' | 'paid' | 'refund_requested' | 'refunded' | 'waiting_payment' | 'refused' | 'blocked' | 'chargedback' | 'canceled' | 'in_protest' | 'partially_paid' | 'prechargeback' | 'scheduled' | 'retrying' | 'MED'
  • processing - Processando
  • authorized - Autorizado
  • paid - Pago
  • refund_requested - Reembolso solicitado
  • 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
type'unique' | 'subscription'
  • unique - Pagamento único
  • subscription - Assinatura recorrente
offer_type'main' | 'upsell' | 'downsell' | 'orderbump'
  • main - Principal
  • upsell - Upsell
  • downsell - Downsell
  • orderbump - Order Bump
baseAmountstring decimal required

Valor base do pedido antes de descontos e taxas

discountstring decimal nullable

Valor do desconto aplicado no pedido

amountstring decimal nullable

Valor total do pedido após descontos e taxas

couponCodestring nullable

Código do cupom de desconto aplicado no pedido

reasonstring nullable

Motivo de recusa do pagamento

refund_reasonstring nullable

Descrição do motivo do reembolso do pedido

checkoutinteger nullable

Checkout onde a compra foi realizada

subscriptionstring nullable

Assinatura associada ao pedido

subscription_periodinteger nullable

Período da assinatura que este pedido corresponde

installmentsinteger

Número de parcelas que o valor foi dividido

paymentMethodstring required

Método de pagamento utilizado na compra

createdAtstring date-time required

Data e hora de criação

due_datestring date-time nullable

Data e hora em que o pagamento será processado

paidAtstring date-time nullable

Data e hora em que o pedido foi pago

releaseDatestring date-time nullable

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

refundedAtstring date-time nullable

Data e hora em que o pedido foi reembolsado

chargedbackAtstring date-time nullable

Data e hora que o chargeback foi realizado

canceledAtstring date-time nullable

Data e hora de cancelamento do pedido

feesstring decimal nullable

Valor total das taxas aplicadas ao pedido

utm_sourcestring nullable

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

utm_mediumstring nullable

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

utm_campaignstring nullable

Nome da campanha (ex: promocao_2023)

utm_termstring nullable

Termo da campanha (ex: sapato+vermelho)

utm_contentstring nullable

Conteúdo da campanha (ex: banner_superior)

sckstring nullable

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

checkoutUrlstring nullable

URL do checkout onde o pedido foi realizado

Changes

No recorded changes to this operation across all 1 revision of this API.