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

# Consultar programada

> Ao acionar, são retornadas todas as solicitações programadas da central conforme os parâmetros informados. O endereço de origem vem em `coleta`.



## OpenAPI

````yaml pages/v1/openapi-entregas.json GET /consultarProgramada
openapi: 3.1.0
info:
  title: API de Integração
  description: API de Integração v1
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-vendas.taximachine.com.br/api/integracao
  - url: https://api.taximachine.com.br/api/integracao
security:
  - basicAuth: []
    ApiKeyAuth: []
paths:
  /consultarProgramada:
    get:
      summary: Consultar solicitações programadas
      description: >-
        Ao acionar, são retornadas todas as solicitações programadas da central
        conforme os parâmetros informados. O endereço de origem vem em `coleta`.
      parameters:
        - name: id_mch_programada
          in: query
          description: ID da solicitação que se deseja consultar, de forma específica.
          schema:
            type: integer
        - name: limite
          in: query
          description: >-
            Quantidade de solicitações programadas retornadas. O limite padrão é
            20 e o máximo é 100.
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: pagina
          in: query
          description: Qual início da contagem para o limite. O padrão é 1.
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                response:
                  - id_mch_programada: '1394'
                    situacao: A
                    situacao_formatada: Aguardando distribuição
                    data_previsao_disparo: 12/12/2023
                    hora_previsao_disparo: '17:32:18'
                    id_mch: null
                    observacao: Retirar no balcão
                    empresa:
                      id: '427'
                      nome: empresa_nome
                    categoria:
                      id: '3'
                      nome: Entrega Moto
                    valor:
                      estimado: '12.50'
                      prefixado: null
                    coleta:
                      endereco: Rua da Coleta, 10
                      complemento: Loja 2
                      referencia: Em frente à praça
                      bairro: Centro
                      cidade: João Pessoa
                      estado: PB
                      lat: '-7.115000000'
                      lng: '-34.834000000'
                    paradas:
                      - id: '900'
                        ordem: 0
                        endereco: Rua das Palmeiras, 200
                        complemento: Apto 31
                        referencia: Ao lado do mercado
                        bairro: Centro
                        cidade: João Pessoa
                        uf: PB
                        lat: '-7.209233800'
                        lng: '-34.878063100'
                        numero_pedido: PED-123
                        nome_cliente: Maria Souza
                        telefone_cliente: '+5583999990000'
                        observacao: Entregar na portaria
                      - id: '901'
                        ordem: 1
                        endereco: Avenida Epitácio Pessoa, 1500
                        complemento: null
                        referencia: null
                        bairro: Tambaú
                        cidade: João Pessoa
                        uf: PB
                        lat: '-7.115000000'
                        lng: '-34.834000000'
                        numero_pedido: PED-124
                        nome_cliente: João Lima
                        telefone_cliente: '+5583988887777'
                        observacao: null
                  - id_mch_programada: '1393'
                    situacao: C
                    situacao_formatada: Cancelada
                    data_previsao_disparo: 26/01/2021
                    hora_previsao_disparo: '01:50:00'
                    id_mch: null
                    observacao: null
                    empresa:
                      id: null
                      nome: null
                    categoria:
                      id: '3'
                      nome: Entrega Moto
                    valor:
                      estimado: '12.50'
                      prefixado: null
                    coleta:
                      endereco: Rua da Coleta, 10
                      complemento: Loja 2
                      referencia: Em frente à praça
                      bairro: Centro
                      cidade: João Pessoa
                      estado: PB
                      lat: '-7.115000000'
                      lng: '-34.834000000'
                    paradas:
                      - id: '900'
                        ordem: 0
                        endereco: Rua das Palmeiras, 200
                        complemento: Apto 31
                        referencia: Ao lado do mercado
                        bairro: Centro
                        cidade: João Pessoa
                        uf: PB
                        lat: '-7.209233800'
                        lng: '-34.878063100'
                        numero_pedido: PED-123
                        nome_cliente: Maria Souza
                        telefone_cliente: '+5583999990000'
                        observacao: Entregar na portaria
                  - id_mch_programada: '1392'
                    situacao: D
                    situacao_formatada: Distribuída
                    data_previsao_disparo: 21/01/2021
                    hora_previsao_disparo: '00:55:00'
                    id_mch: '100003594'
                    observacao: null
                    empresa:
                      id: '726'
                      nome: empresa_nome
                    categoria:
                      id: '3'
                      nome: Entrega Moto
                    valor:
                      estimado: '12.50'
                      prefixado: null
                    coleta:
                      endereco: Rua da Coleta, 10
                      complemento: Loja 2
                      referencia: Em frente à praça
                      bairro: Centro
                      cidade: João Pessoa
                      estado: PB
                      lat: '-7.115000000'
                      lng: '-34.834000000'
                    paradas:
                      - id: '900'
                        ordem: 0
                        endereco: Rua das Palmeiras, 200
                        complemento: Apto 31
                        referencia: Ao lado do mercado
                        bairro: Centro
                        cidade: João Pessoa
                        uf: PB
                        lat: '-7.209233800'
                        lng: '-34.878063100'
                        numero_pedido: PED-123
                        nome_cliente: Maria Souza
                        telefone_cliente: '+5583999990000'
                        observacao: Entregar na portaria
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````