Status

Listar Pedidos

Listar pedidos

get
/v2/orders

Retorna uma lista paginada de pedidos com filtros

Authorizations
Query parameters
customerDocumentstringOptional

Documento do cliente para filtro

namestringOptional

Nome para filtro

emailstring · emailOptional

Email para filtro

documentstringOptional

Documento para filtro

notificationEmailstring · emailOptional

Email de notificação para filtro

statusstring · enumOptional

Status do pedido para filtro

Possible values:
paymentMethodstringOptional

Método de pagamento para filtro

expirationDateInitialstring · dateOptional

Data inicial de expiração para filtro

expirationDateFinalstring · dateOptional

Data final de expiração para filtro

pageinteger · int32Optional

Número da página (começando em 0)

Default: 0
sizeinteger · int32 · min: 1Optional

Quantidade de itens por página

Default: 20
sortstring[]Optional

Critérios de ordenação (sort=name,asc&sort=createdAt,desc)

idempotencyKeystringOptional

Chave de idempotência como query parameter

Header parameters
X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumOptional

Tipo de conteúdo da requisição

Possible values:
x-ip-origin-requeststringOptional

IP de origem da requisição

x-idempotency-keystringOptional

Chave de idempotência

Responses
200

Lista de pedidos retornada com sucesso

application/json
get
/v2/orders
GET /v2/orders HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*

{
  "content": [
    {
      "uuid": "be0e4f86-8a01-4bcf-abca-b76bec8862fd",
      "status": "REFUND",
      "title": "Fatura mensal do cliente",
      "description": "Licença de uso do aplicativo e plataforma customizados licenciados pela MobApps no valor de R$ 13103,64. Competência 12/2022",
      "value": 11.5,
      "installments": 1,
      "startDate": "2025-04-03",
      "payment": "CREDIT_CARD",
      "customer": {
        "uuid": "",
        "document": "001052647",
        "type": "SSN",
        "documentCountry": "US",
        "name": "Joshua Henry",
        "email": "[email protected]",
        "phone": "9409822523",
        "alternativeEmail": ""
      },
      "idempotencyKey": "580526fc-b693-4626-bab6-1b270fb2e76f",
      "charges": [
        {
          "uuid": "9e128686-4111-40be-ad9f-95df157f55da",
          "title": "Fatura mensal do cliente",
          "expirationDate": "2025-04-03",
          "paidDate": "2025-04-03",
          "value": 11.5,
          "paymentMethod": "CREDIT_CARD",
          "status": "REFUND",
          "customer": {
            "uuid": "",
            "document": "001052647",
            "type": "SSN",
            "documentCountry": "US",
            "name": "Joshua Henry",
            "email": "[email protected]",
            "phone": "9409822523",
            "alternativeEmail": ""
          },
          "authorizationCode": "224615",
          "authorizationNsu": "100365",
          "refunds": [
            {}
          ],
          "retryable": false
        }
      ]
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1
}
PreviousCancelar PedidoNextSimular Parcelamento

Last updated

Was this helpful?