Skip to main content
GET
/
consultarProgramada
Consultar solicitações programadas
curl --request GET \
  --url https://api-vendas.taximachine.com.br/api/integracao/consultarProgramada \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'api-key: <api-key>'
{
  "success": true,
  "response": [
    {
      "id_mch_programada": "1394",
      "situacao": "Aguardando Distribuição",
      "situacao_formatada": "12/12/2023 17:32:18",
      "data_previsao_disparo": "12/12/2023",
      "hora_previsao_disparo": "17:32:18",
      "id_mch": null,
      "empresa": {
        "id": "427",
        "nome": "empresa_nome"
      }
    },
    {
      "id_mch_programada": "1393",
      "situacao": "Cancelada",
      "situacao_formatada": "26/01/2021 01:50:00",
      "data_previsao_disparo": "26/01/2021",
      "hora_previsao_disparo": "01:50:00",
      "id_mch": null,
      "empresa": {
        "id": null,
        "nome": null
      }
    },
    {
      "id_mch_programada": "1392",
      "situacao": "Distribuída",
      "situacao_formatada": "21/01/2021 00:55:00",
      "data_previsao_disparo": "21/01/2021",
      "hora_previsao_disparo": "00:55:00",
      "id_mch": "100003594",
      "empresa": {
        "id": "726",
        "nome": "empresa_nome"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Query Parameters

id_mch_programada
integer

ID da solicitação que se deseja consultar, de forma específica.

limite
integer
default:20

Quantidade de solicitações programadas retornadas. O limite padrão é 20 e o máximo é 100.

Required range: x <= 100
pagina
integer
default:1

Qual início da contagem para o limite. O padrão é 1.

Response

200 - application/json

Sucesso

The response is of type object.