Sign in

v1

latestOpenAPI 3.1.02026-07-265314114.3 KB
Orders

Update Order

Atualiza um pedido.

patch/app/order/{order_id}

Path parameters

order_idstring required

ID do pedido

Request body

status'APPROVED' | 'REFUNDED'

Status do pedido: APPROVED ou REFUNDED

client_identifierstring

Identificador do comprador

client_discordstring

Discord ID do comprador

Response

OK

store_idnumber

ID da loja

client_identifierstring

Identificador do cliente

client_emailstring

Email do cliente

client_namestring

Nome do cliente

client_documentstring nullable

Documento do cliente

client_phonestring nullable

Telefone do cliente

client_discordstring nullable

Discord ID do cliente

pricenumber

Valor total do pedido

net_receivednumber

Valor recebido pelo gateway

internal_idstring

Identificador interno do pedido

external_idstring

Identificador do pedido pelo gateway

promo_codestring nullable

Cupom de desconto utilizado na compra

promo_type'PERCENTAGE' | 'PRICE' nullable

Tipo do cupom de desconto: PERCENTAGE ou PRICE

promo_valuenumber nullable

Valor do cupom de desconto

gatewaystring

Método de pagamento utilizado

status'APPROVED' | 'REJECTED' | 'CANCELED' | 'REFUNDED' | 'CHARGEDBACK' | 'PENDING'

Status do pedido: APPROVED, REJECTED, CANCELED, REFUNDED, CHARGEDBACK, PENDING

currency'BRL' | 'USD' | 'EUR'

Moeda utilizada na compra: BRL, USD, EUR

manually_createdboolean

Indica se o pedido foi criado manualmente

manually_refundedboolean

Indica se o pedido foi reembolsado manualmente

manually_approvedboolean

Indica se o pedido foi aprovado manualmente

paid_atstring nullable

Data em que o pedido foi pago

created_atstring

Data de criação do pedido

updated_atstring

Data da última atualização do pedido

price_displaystring

Preço formatado para exibição

status_displaystring

Status formatado para exibição

gateway_displaystring

Gateway formatado para exibição