Skip to main content
PATCH
https://api.centralcart.com.br
/
v1
/
app
/
order
/
{order_id}
Update Order
curl --request PATCH \
  --url https://api.centralcart.com.br/v1/app/order/{order_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>",
  "client_identifier": "<string>",
  "client_discord": "<string>",
  "variables": {},
  "manually_approved": true,
  "manually_refunded": true
}
'
{
  "store_id": 2,
  "client_identifier": "12345",
  "client_email": "support@centralcart.com",
  "client_name": "Central",
  "client_document": null,
  "client_phone": null,
  "client_discord": "000000000000000000",
  "price": 100,
  "net_received": 0,
  "internal_id": "bE9GTvID3Pou",
  "external_id": "2HnFQyFdGBM3",
  "promo_code": null,
  "promo_type": null,
  "promo_value": null,
  "gateway": "PIX",
  "status": "PENDING",
  "manually_created": false,
  "manually_refunded": false,
  "manually_approved": false,
  "paid_at": null,
  "created_at": "2024-09-04T15:44:47.000-03:00",
  "updated_at": "2024-09-04T15:44:47.000-03:00",
  "currency": "BRL",
  "variables": [
    {
      "id": 105328,
      "store_id": 2,
      "order_id": 356925,
      "name": "client_identifier",
      "value": "12345",
      "created_at": "2024-09-04T15:44:47.000-03:00",
      "updated_at": "2024-09-04T15:44:47.000-03:00"
    }
  ],
  "price_display": "R$ 100,00",
  "status_display": "PENDENTE",
  "gateway_display": "Pix"
}
order_id
string
required
ID do pedido
status
string
Status do pedido: APPROVED ou REFUNDED
client_identifier
string
Identificador do comprador
client_discord
string
Discord ID do comprador
variables
object
Objeto com valores de variáveis de checkout (chave: nome da variável, valor: valor da variável)
manually_approved
boolean
Indica se o pedido foi aprovado manualmente
manually_refunded
boolean
Indica se o pedido foi reembolsado manualmente

Response

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
string | null
Tipo do cupom de desconto: PERCENTAGE ou PRICE
promo_value
number | null
Valor do cupom de desconto
gateway
string
Método de pagamento utilizado
status
string
Status do pedido: APPROVED, REJECTED, CANCELED, REFUNDED, CHARGEDBACK, PENDING
currency
string
Moeda utilizada na compra: 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
{
  "store_id": 2,
  "client_identifier": "12345",
  "client_email": "support@centralcart.com",
  "client_name": "Central",
  "client_document": null,
  "client_phone": null,
  "client_discord": "000000000000000000",
  "price": 100,
  "net_received": 0,
  "internal_id": "bE9GTvID3Pou",
  "external_id": "2HnFQyFdGBM3",
  "promo_code": null,
  "promo_type": null,
  "promo_value": null,
  "gateway": "PIX",
  "status": "PENDING",
  "manually_created": false,
  "manually_refunded": false,
  "manually_approved": false,
  "paid_at": null,
  "created_at": "2024-09-04T15:44:47.000-03:00",
  "updated_at": "2024-09-04T15:44:47.000-03:00",
  "currency": "BRL",
  "variables": [
    {
      "id": 105328,
      "store_id": 2,
      "order_id": 356925,
      "name": "client_identifier",
      "value": "12345",
      "created_at": "2024-09-04T15:44:47.000-03:00",
      "updated_at": "2024-09-04T15:44:47.000-03:00"
    }
  ],
  "price_display": "R$ 100,00",
  "status_display": "PENDENTE",
  "gateway_display": "Pix"
}