Consulta de cenários
Objetivo: Consultar os cenários existentes no cadastro de um cliente. Os campos de filtros são enviados como parâmetros da URL endpoint da requisição (não há body). Consultar o Swagger para obter os filtros possíveis.
Descrição dos campos de retorno:
| Campo | PAI | Descrição |
| success | / | Status do retorno |
| message | / | Mensagem do retorno |
| record_count | / | Quantidade de cenários retornados |
| id | data | ID do cenário |
| id_cliente | data | ID do cliente |
| grupo_cache | data | uso interno Systax |
| uf_origem | data | UF do remetente |
| uf_destino | data | UF do destinatário |
| alternativo_ex_origem | data | Perfil do remetente |
| destinacao | data | Perfil do destinatário |
| cod_nat_op | data | Código de natureza de operação |
| finalidade | data | Destinação dada às mercadorias |
| ent_sai | data | Tipo entrada/saída |
| frequencia | data | uso interno Systax |
| dias_futuros | data | uso interno Systax |
| apelido | data | Descrição do cenário |
| origem_produto_alternativo | data | uso interno Systax |
| st_cest | data | uso interno Systax |
| id_mun_origem | data | ID município do remetente |
| id_mun_destino | data | ID município do destinatário |
| cenario_ind_prod | data | uso interno Systax |
| cnpj_ex_origem | data | CNPJ do remetente |
| cnae_destinatario | data | CNAE do destinatário |
Tabela de referência para o campo "ent_sai":
| ent_sai | Descrição |
| 0 | Entrada |
| 1 | Saída |
Tabelas de referência para os campos "alternativo_ex_origem" , "destinacao", "finalidade" e "cod_nat_op":
Para obter informações sobre as tabelas dos campos acima, acesse o tópico "Cadastro de cenarios em lote" deste manual.
Exemplos de chamada:
Exemplos de retorno:
{
"success": true,
"message": "ok",
"record_count": 1,
"data": [
{
"id": "150462",
"id_cliente": "71408",
"grupo_cache": "A",
"uf_origem": "SP",
"uf_destino": "SP",
"alternativo_ex_origem": "1",
"destinacao": "138",
"cod_nat_op": "120",
"ent_sai": "1",
"frequencia": "0",
"dias_futuros": "30",
"apelido": "Compra-SP-SP-Industria-Atacado",
"origem_produto_alternativo": "",
"st_cest": "1",
"id_mun_origem": "",
"id_mun_destino": "",
"cenario_ind_prod": "",
"cnpj_ex_origem": "",
"cnae_destinatario": "",
"dt_criacao": "2017-06-02 17:40:00"
}
]
}