Lista de produtos disponiveis

GET /product/list

HTTP

GET /product/list HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Para listar os produtos disponiveis, utilizamos a seguinte url: {{url}}/product/list

URL Params

Query string	Tipo	Descrição	Obrigatório
fields	Query string	O valor da query é os campos disponiveis separados por virgulas, query usada para montar o retorno do objeto.	✗
conditions[fieldName]	Query string	O valor da query é o dado do campo informado entre os "[]", query usada como condição para filtrar o retorno de dados.	✗

Campos disponiveis para montar o objeto e / ou filtrar a lista.

Campo	Query string	Descrição	Obrigatório
id	fields & conditions[fieldName]	Identificador	✗
alterado_em	fields & conditions[fieldName]	Mostra quando os dados foram alterados	✗
alterado_por	fields & conditions[fieldName]	Mostra quem alterou os dados	✗
criado_em	fields & conditions[fieldName]	Mostra quando os dados foram criados	✗
nome	fields & conditions[fieldName]	Nome do produto	✗

Requisição

GET

GET {{url}}/product/list

Resposta

200

{
    "status": "success",
    "message": "Lista de produtos",
    "document": [
        {
          destaque: string | null;
          destaque_descricao: string | null;
          id: number;
          nome: string;
          valor: number;
          codigo_produto: number;
          assinatura_eletronica: string;
          id_agrupamento: number;
          sigla: string;
          complemento: string | null;
          cpf_cnpj_empresa_responsavel: string;
          credito: boolean;
          debito: boolean;
          desconto_em_folha: boolean;
          alterado_em: string; // ISO date string
          alterado_por: string;
          criado_em: string; // ISO date string
          status: string;
          vinculo_cep: boolean;
          codigo_integracao: number;
          entidades: boolean;
          tipo_beneficio: string | null;
          aceita_ecommerce: boolean;
          aceita_praca: boolean;
          e_nichado: boolean;
        },
    ]
}

Errors

Código	Referência	Explicação
400	BAD REQUEST	O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401	UNAUTHORIZED	O servidor não autorizou a requisição. Access Token inválido.
403	FORBIDDEN	O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404	NOT FOUND	O servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422	UNPROCESSABLE ENTITY	O servidor não conseguiu processar as informações contidas na requisição.