Skip to main content
GET
/
referrals
/
delivery
curl --request GET \
  --url 'https://backend.testeswaffle.org/referrals/delivery?startDate=2024-01-01&format=json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

{
  "success": true,
  "data": {
    "deliveries": [
      {
        "delivery_id": "del_123456789",
        "user_email": "[email protected]",
        "product_id": "prod_001",
        "product_name": "Kit Premium the news",
        "delivery_address": {
          "street": "Rua Exemplo",
          "number": "123",
          "complement": "Apto 456",
          "city": "São Paulo",
          "state": "SP",
          "zip_code": "01234-567"
        },
        "submitted_at": "2024-01-20T10:30:00Z",
        "status": "pending"
      }
    ],
    "pagination": {
      "total": 45,
      "page": 1,
      "limit": 20,
      "pages": 3
    }
  }
}

​
Descrição

Lista as respostas dos formulários de entrega submetidos pelos usuários. Requer autenticação JWT.

​
Headers

​
Authorization
string
required
Token JWT no formato: Bearer

​
Query Parameters

​
startDate
string
Data inicial no formato YYYY-MM-DD
​
endDate
string
Data final no formato YYYY-MM-DD
​
productId
string
ID do produto para filtrar
​
email
string
Email do usuário para filtrar
​
page
number
default:"1"
Número da página
​
limit
number
default:"20"
Número de itens por página
​
sort
string
default:"desc"
Ordenação: asc ou desc
​
sortField
string
default:"created_at"
Campo para ordenação
​
format
string
default:"json"
Formato da resposta: json ou csv

​
Response

​
success
boolean
Indica se a operação foi bem-sucedida
​
data
object
curl --request GET \
  --url 'https://backend.testeswaffle.org/referrals/delivery?startDate=2024-01-01&format=json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

{
  "success": true,
  "data": {
    "deliveries": [
      {
        "delivery_id": "del_123456789",
        "user_email": "[email protected]",
        "product_id": "prod_001",
        "product_name": "Kit Premium the news",
        "delivery_address": {
          "street": "Rua Exemplo",
          "number": "123",
          "complement": "Apto 456",
          "city": "São Paulo",
          "state": "SP",
          "zip_code": "01234-567"
        },
        "submitted_at": "2024-01-20T10:30:00Z",
        "status": "pending"
      }
    ],
    "pagination": {
      "total": 45,
      "page": 1,
      "limit": 20,
      "pages": 3
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
startDate
string<date>

Data inicial (YYYY-MM-DD)

​
endDate
string<date>

Data final (YYYY-MM-DD)

​
productId
string

ID do produto

​
email
string

Email do usuário

​
page
number
default:1

Número da página

​
limit
number
default:20

Itens por página

​
sort
enum<string>
default:desc

Ordenação

Available options:
asc,
desc
​
sortField
string
default:created_at

Campo para ordenação

​
format
enum<string>
default:json

Formato da resposta

Available options:
json,
csv

Response

200 - application/json

Lista de entregas

​
success
boolean
​
data
object