Skip to main content
PATCH
Update Order

Autorizações

Authorization
string
header
obrigatório

Token de API gerado no painel da CentralCart.

Parâmetros de caminho

order_id
string
obrigatório

ID do pedido

Corpo

application/json
status
enum<string>

Status do pedido: APPROVED ou REFUNDED

Opções disponíveis:
APPROVED,
REFUNDED
client_identifier
string

Identificador do comprador

client_discord
string

Discord ID do comprador

variables
object[]

Lista de campos de checkout a sobrescrever. Cada item deve conter name (nome da variável de checkout configurada na loja) e value (novo valor). Variáveis existentes têm seu valor atualizado; nomes ainda não vinculados ao pedido são criados.

package_options
object[]

Lista de escolhas de produto a sobrescrever (variáveis de pacote definidas pelo comprador no checkout). Cada item deve conter o id da escolha e ao menos um dos campos: value (texto/número) ou variable_option_id (para variáveis do tipo SELECT).

Resposta

200 - application/json

OK

store_id
number

ID da loja

client_identifier
string

Identificador do cliente

client_email
string

Email do cliente

client_name
string

Nome do cliente

client_document
string | null

Documento do cliente

client_phone
string | null

Telefone do cliente

client_discord
string | null

Discord ID do cliente

price
number

Valor total do pedido

net_received
number

Valor recebido pelo gateway

internal_id
string

Identificador interno do pedido

external_id
string

Identificador do pedido pelo gateway

promo_code
string | null

Cupom de desconto utilizado na compra

promo_type
enum<string> | null

Tipo do cupom de desconto: PERCENTAGE ou PRICE

Opções disponíveis:
PERCENTAGE,
PRICE
promo_value
number | null

Valor do cupom de desconto

gateway
string

Método de pagamento utilizado

status
enum<string>

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

Opções disponíveis:
APPROVED,
REJECTED,
CANCELED,
REFUNDED,
CHARGEDBACK,
PENDING
currency
enum<string>

Moeda utilizada na compra: BRL, USD, EUR

Opções disponíveis:
BRL,
USD,
EUR
manually_created
boolean

Indica se o pedido foi criado manualmente

manually_refunded
boolean

Indica se o pedido foi reembolsado manualmente

manually_approved
boolean

Indica se o pedido foi aprovado manualmente

paid_at
string | null

Data em que o pedido foi pago

created_at
string

Data de criação do pedido

updated_at
string

Data da última atualização do pedido

variables
array

Variáveis de checkout do pedido

price_display
string

Preço formatado para exibição

status_display
string

Status formatado para exibição

gateway_display
string

Gateway formatado para exibição