Skip to main content
GET
https://api.centralcart.com.br
/
v1
/
app
/
order
List Order
curl --request GET \
  --url https://api.centralcart.com.br/v1/app/order
{
  "meta": {
    "total": 1,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "first_page": 1,
    "first_page_url": "/?page=1",
    "last_page_url": "/?page=1",
    "next_page_url": null,
    "previous_page_url": null
  },
  "data": [
    {
      "store_id": 1,
      "internal_id": "1b2fe2a9697a0ac07ebd933309b4f9a8d1120c06",
      "gateway": "PIX",
      "price": 5,
      "client_identifier": "1",
      "client_name": "Central Cart",
      "client_email": "support@centralcart.com.br",
      "currency": "BRL",
      "paid_at": "2024-03-03T23:43:12.000-03:00",
      "created_at": "2024-03-03T23:43:12.000-03:00",
      "updated_at": "2024-03-03T23:43:12.000-03:00",
      "status": "APPROVED",
      "promo_code": null,
      "promo_type": null,
      "promo_value": null
    }
  ]
}
​
page
number
Número da página para paginação (padrão: 1)
​
limit
number
Limite de itens por página (máximo: 15, padrão: 15)
​
status
string | string[]
Status do pedido: APPROVED, REJECTED, CANCELED, REFUNDED, CHARGEDBACK. Pode ser um array para filtrar múltiplos status
​
email
string
Filtrar pedidos por email do cliente (busca parcial)
​
client_id
string
Filtrar pedidos por ID do cliente
​
user_id
string
Filtrar pedidos por ID do usuário (alias para client_id)
​
q
string
Busca geral que pesquisa em: identificador do cliente, email, Discord ID, nome, telefone, cupom de desconto, internal_id e external_id
​
pay_id
string
Filtrar pedidos por ID externo do gateway de pagamento
​
package
number | number[]
Filtrar pedidos por ID(s) do(s) pacote(s)
​
discount
number | number[]
Filtrar pedidos por ID(s) do(s) desconto(s)
​
variables
string | string[]
Filtrar pedidos por nome(s) da(s) variável(is)
​
gateways
string | string[]
Filtrar pedidos por gateway(s) de pagamento
​
affiliates
number | number[]
Filtrar pedidos por ID(s) do(s) afiliado(s)
​
from
string
Data inicial para filtrar pedidos (formato: YYYY-MM-DD). Deve ser usado junto com to
​
to
string
Data final para filtrar pedidos (formato: YYYY-MM-DD). Deve ser usado junto com from

​
Response

​
meta
object
Metadados de paginação
​
data
array
Lista de pedidos
{
  "meta": {
    "total": 1,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "first_page": 1,
    "first_page_url": "/?page=1",
    "last_page_url": "/?page=1",
    "next_page_url": null,
    "previous_page_url": null
  },
  "data": [
    {
      "store_id": 1,
      "internal_id": "1b2fe2a9697a0ac07ebd933309b4f9a8d1120c06",
      "gateway": "PIX",
      "price": 5,
      "client_identifier": "1",
      "client_name": "Central Cart",
      "client_email": "support@centralcart.com.br",
      "currency": "BRL",
      "paid_at": "2024-03-03T23:43:12.000-03:00",
      "created_at": "2024-03-03T23:43:12.000-03:00",
      "updated_at": "2024-03-03T23:43:12.000-03:00",
      "status": "APPROVED",
      "promo_code": null,
      "promo_type": null,
      "promo_value": null
    }
  ]
}