> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thenewscc.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar Entregas

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

## Descrição

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

## Headers

<ParamField header="Authorization" type="string" required>
  Token JWT no formato: Bearer {token}
</ParamField>

## Query Parameters

<ParamField query="startDate" type="string">
  Data inicial no formato YYYY-MM-DD
</ParamField>

<ParamField query="endDate" type="string">
  Data final no formato YYYY-MM-DD
</ParamField>

<ParamField query="productId" type="string">
  ID do produto para filtrar
</ParamField>

<ParamField query="email" type="string">
  Email do usuário para filtrar
</ParamField>

<ParamField query="page" type="number" default="1">
  Número da página
</ParamField>

<ParamField query="limit" type="number" default="20">
  Número de itens por página
</ParamField>

<ParamField query="sort" type="string" default="desc">
  Ordenação: asc ou desc
</ParamField>

<ParamField query="sortField" type="string" default="created_at">
  Campo para ordenação
</ParamField>

<ParamField query="format" type="string" default="json">
  Formato da resposta: json ou csv
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Indica se a operação foi bem-sucedida
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="properties">
    <ResponseField name="deliveries" type="array">
      <Expandable title="delivery object">
        <ResponseField name="delivery_id" type="string">
          ID único da entrega
        </ResponseField>

        <ResponseField name="user_email" type="string">
          Email do usuário
        </ResponseField>

        <ResponseField name="product_id" type="string">
          ID do produto
        </ResponseField>

        <ResponseField name="product_name" type="string">
          Nome do produto
        </ResponseField>

        <ResponseField name="delivery_address" type="object">
          <Expandable title="address fields">
            <ResponseField name="street" type="string">
              Rua
            </ResponseField>

            <ResponseField name="number" type="string">
              Número
            </ResponseField>

            <ResponseField name="complement" type="string">
              Complemento
            </ResponseField>

            <ResponseField name="city" type="string">
              Cidade
            </ResponseField>

            <ResponseField name="state" type="string">
              Estado
            </ResponseField>

            <ResponseField name="zip_code" type="string">
              CEP
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="submitted_at" type="string">
          Data de submissão
        </ResponseField>

        <ResponseField name="status" type="string">
          Status da entrega
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pagination" type="object">
      <Expandable title="properties">
        <ResponseField name="total" type="number">
          Total de registros
        </ResponseField>

        <ResponseField name="page" type="number">
          Página atual
        </ResponseField>

        <ResponseField name="limit" type="number">
          Itens por página
        </ResponseField>

        <ResponseField name="pages" type="number">
          Total de páginas
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url 'https://backend.testeswaffle.org/referrals/delivery?startDate=2024-01-01&format=json' \
    --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "deliveries": [
        {
          "delivery_id": "del_123456789",
          "user_email": "usuario@exemplo.com",
          "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
      }
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /referrals/delivery
openapi: 3.1.0
info:
  title: Referrals API
  description: API para gerenciamento do programa de indicações do the news
  version: 1.0.0
servers:
  - url: https://backend.testeswaffle.org
security:
  - bearerAuth: []
paths:
  /referrals/delivery:
    get:
      tags:
        - Authenticated
      summary: Listar Entregas
      description: Lista as respostas dos formulários de entrega. Requer autenticação JWT.
      parameters:
        - name: startDate
          in: query
          schema:
            type: string
            format: date
          description: Data inicial (YYYY-MM-DD)
        - name: endDate
          in: query
          schema:
            type: string
            format: date
          description: Data final (YYYY-MM-DD)
        - name: productId
          in: query
          schema:
            type: string
          description: ID do produto
        - name: email
          in: query
          schema:
            type: string
          description: Email do usuário
        - name: page
          in: query
          schema:
            type: number
            default: 1
          description: Número da página
        - name: limit
          in: query
          schema:
            type: number
            default: 20
          description: Itens por página
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Ordenação
        - name: sortField
          in: query
          schema:
            type: string
            default: created_at
          description: Campo para ordenação
        - name: format
          in: query
          schema:
            type: string
            enum:
              - json
              - csv
            default: json
          description: Formato da resposta
      responses:
        '200':
          description: Lista de entregas
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      deliveries:
                        type: array
                        items:
                          type: object
                      pagination:
                        type: object
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````