Vendas

Alterar status

Atualiza o status da venda (ex.: marcar como paga). Isso pode disparar a emissão automática da nota quando o autoIssueMode da venda depende do pagamento (ex.: afterPayment).

put/v1/orders/{id}/status

Request

  • Base URL: https://api.spedy.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api.spedy.com.br/v1/orders/{id}/status
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

Request body

status'created' | 'awaitingPayment' | 'approved' | 'refundRequested' | 'completed' | 'chargeback' | 'canceled' | 'refunded' | 'expired' | 'refused' | 'deleted'

Situação da venda<p>Valores possíveis:</p>

<ul> <li><b>created</b>: Criado</li> <li><b>awaitingPayment</b>: Aguardando pagamento</li> <li><b>approved</b>: Aprovado</li> <li><b>refundRequested</b>: Reembolso solicitado</li> <li><b>completed</b>: Concluído</li> <li><b>chargeback</b>: Chargeback</li> <li><b>canceled</b>: Cancelado</li> <li><b>refunded</b>: Reembolsado</li> <li><b>expired</b>: Vencido</li> <li><b>refused</b>: Recusado</li> <li><b>deleted</b>: Deletado</li> </ul>

Response

OK

idstring uuid

ID da Venda

transactionIdstring nullable

Código da Transação

datestring date-time

Data da Venda

amountnumber double

Valor total

status'created' | 'awaitingPayment' | 'approved' | 'refundRequested' | 'completed' | 'chargeback' | 'canceled' | 'refunded' | 'expired' | 'refused' | 'deleted'

Situação da venda<p>Valores possíveis:</p>

<ul> <li><b>created</b>: Criado</li> <li><b>awaitingPayment</b>: Aguardando pagamento</li> <li><b>approved</b>: Aprovado</li> <li><b>refundRequested</b>: Reembolso solicitado</li> <li><b>completed</b>: Concluído</li> <li><b>chargeback</b>: Chargeback</li> <li><b>canceled</b>: Cancelado</li> <li><b>refunded</b>: Reembolsado</li> <li><b>expired</b>: Vencido</li> <li><b>refused</b>: Recusado</li> <li><b>deleted</b>: Deletado</li> </ul>
sourcePlatform'spedy' | 'hotmart' | 'monetizze' | 'eduzz' | 'braip' | 'shopify' | 'iugu' | 'pagarme' | 'kiwify' | 'mercadoPago' | 'yampi' | 'nuvemshop' | 'cartpanda' | 'stripe' | 'perfectPay' | 'evermart' | 'cyclopay' | 'greenn' | 'woocommerce' | 'afiliaPay' | 'blueticket' | 'abmex' | 'asaas' | 'doppus' | 'dooca' | 'vindi' | 'guru' | 'ticto' | 'eadPlataforma' | 'provi' | 'blitzPay' | 'payt' | 'eventiza' | 'pepper' | 'appMax' | 'voomp' | 'xgrow' | 'kirvano' | 'theMart' | 'hubla' | 'payPal' | 'tmb' | 'lastlink' | 'vega' | 'doppusV2' | 'cakto' | 'wix' | 'wBuy' | 'pepperV2' | 'neonPay' | 'assiny' | 'pagTrust' | 'wiapy' | 'onProfit' | 'edunext' | 'yampiV2' | 'yever' | 'tikTokShop' | 'luna' | 'bilion' | 'shopee' | 'b4you' | 'vegaV2' | 'domPagamentos' | 'neofin' | 'pagBank' | 'lia' | 'yuno' | 'theMembers' | 'digistore24' | 'heroSpark' | 'woovi' | 'zouti' | 'eduzzV4' | 'stripeV2' | 'shopeeAffiliate' | 'firePay' | 'abacatePay' | 'syncPay' | 'tutory'

Plataforma de venda integrada<p>Valores possíveis:</p>

<ul> <li><b>spedy</b>: Spedy</li> <li><b>hotmart</b>: Hotmart</li> <li><b>monetizze</b>: Monetizze</li> <li><b>eduzz</b>: Eduzz</li> <li><b>braip</b>: Braip</li> <li><b>shopify</b>: Shopify</li> <li><b>iugu</b>: Iugu</li> <li><b>pagarme</b>: Pagar.me</li> <li><b>kiwify</b>: Kiwify</li> <li><b>mercadoPago</b>: Mercado Pago</li> <li><b>yampi</b>: Yampi</li> <li><b>nuvemshop</b>: Nuvemshop</li> <li><b>cartpanda</b>: Cartpanda</li> <li><b>stripe</b>: Stripe</li> <li><b>perfectPay</b>: PerfectPay</li> <li><b>evermart</b>: Evermart</li> <li><b>cyclopay</b>: Cyclopay</li> <li><b>greenn</b>: Greenn</li> <li><b>woocommerce</b>: WooCommerce</li> <li><b>afiliaPay</b>: AfiliaPay</li> <li><b>blueticket</b>: Blueticket</li> <li><b>abmex</b>: Abmex</li> <li><b>asaas</b>: Asaas</li> <li><b>doppus</b>: Doppus</li> <li><b>dooca</b>: Dooca</li> <li><b>vindi</b>: Vindi</li> <li><b>guru</b>: Guru</li> <li><b>ticto</b>: Ticto</li> <li><b>eadPlataforma</b>: EAD Plataforma</li> <li><b>provi</b>: Provi</li> <li><b>blitzPay</b>: BlitzPay</li> <li><b>payt</b>: Payt</li> <li><b>eventiza</b>: Eventiza</li> <li><b>pepper</b>: Pepper</li> <li><b>appMax</b>: AppMax</li> <li><b>voomp</b>: Voomp</li> <li><b>xgrow</b>: Xgrow</li> <li><b>kirvano</b>: Kirvano</li> <li><b>theMart</b>: The Mart</li> <li><b>hubla</b>: Hubla</li> <li><b>payPal</b>: PayPal</li> <li><b>tmb</b>: TMB</li> <li><b>lastlink</b>: Lastlink</li> <li><b>vega</b>: Vega</li> <li><b>doppusV2</b>: Doppus V2</li> <li><b>cakto</b>: Cakto</li> <li><b>wix</b>: Wix</li> <li><b>wBuy</b>: WBuy</li> <li><b>pepperV2</b>: Pepper V2</li> <li><b>neonPay</b>: NeonPay</li> <li><b>assiny</b>: Assiny</li> <li><b>pagTrust</b>: PagTrust</li> <li><b>wiapy</b>: Wiapy</li> <li><b>onProfit</b>: OnProfit</li> <li><b>edunext</b>: Edunext</li> <li><b>yampiV2</b>: Yampi V2</li> <li><b>yever</b>: Yever</li> <li><b>tikTokShop</b>: TikTok Shop</li> <li><b>luna</b>: Luna</li> <li><b>bilion</b>: Bilion</li> <li><b>shopee</b>: Shopee</li> <li><b>b4you</b>: B4you</li> <li><b>vegaV2</b>: Vega V2</li> <li><b>domPagamentos</b>: Dom Pagamentos</li> <li><b>neofin</b>: Neofin</li> <li><b>pagBank</b>: PagBank</li> <li><b>lia</b>: Lia</li> <li><b>yuno</b>: Yuno</li> <li><b>theMembers</b>: The Members</li> <li><b>digistore24</b>: Digistore24</li> <li><b>heroSpark</b>: HeroSpark</li> <li><b>woovi</b>: Woovi</li> <li><b>zouti</b>: Zouti</li> <li><b>eduzzV4</b>: EduzzV4</li> <li><b>stripeV2</b>: StripeV2</li> <li><b>shopeeAffiliate</b>: Shopee Afiliados</li> <li><b>firePay</b>: FirePay</li> <li><b>abacatePay</b>: AbacatePay</li> <li><b>syncPay</b>: SyncPay</li> <li><b>tutory</b>: Tutory</li> </ul>
autoIssueMode'disabled' | 'immediately' | 'afterPayment' | 'afterWarrency'
<p>Valores possíveis:</p> <ul> <li><b>disabled</b>: Desativado (Manual)</li> <li><b>immediately</b>: Imediatamente (default)</li> <li><b>afterPayment</b>: Após o pagamento</li> <li><b>afterWarrency</b>: Após a garantia</li> </ul>
paymentMethod'billetBank' | 'creditCard' | 'debitCard' | 'pix' | 'paypal' | 'bankTransfer' | 'balanceWallets' | 'other' | 'cash'

Forma de pagamento<p>Valores possíveis:</p>

<ul> <li><b>billetBank</b>: Boleto</li> <li><b>creditCard</b>: Cartão de Crédito</li> <li><b>debitCard</b>: Cartão de Débito</li> <li><b>pix</b>: PIX</li> <li><b>paypal</b>: Paypal</li> <li><b>bankTransfer</b>: Transferência Bancária</li> <li><b>balanceWallets</b>: Saldo da Carteira</li> <li><b>other</b>: Outro</li> <li><b>cash</b>: Dinheiro</li> </ul>

Changes

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