Conteúdo
Paginação
Em rotas paginadas é possível fazer a filtragem e ordenação dos campos através de query params:
| Campo | Descrição | Obs |
|---|---|---|
filters | Parametrização da busca (apenas affiliate) | opcional |
sort | Ordenação (apenas affiliate) | opcional |
page | Página de busca, default: 1, min: 1 | opcional |
size | Tamanho da busca, default: 10, max: 100 | opcional |
Query Param: sort
Faz a ordenação da busca, no formato: sort=fieldName: asc ou desc
Query Param: filters
Monta um objeto de busca no banco de dados baseado nos campos fornecidos
fieldName Representa o campo no banco de dados
operator Operação a ser realizada
value String, número ou lista :value, :'value', :value1,value2,value3 ou :'value1,value2,value3'
Exemplo:
GET: https://partnerhub-sdx-external-api.stone.com.br/affiliates? page=2&size=100&sort:eq:asc&filters=docNumber:eq:'98765432100001';credDate:eq:'01/06/2021'
Operadores:
| Valor | Função |
|---|---|
eq | IGUAL |
neq | NÃO IGUAL (Diferente) |
gt | MAIOR QUE |
gte | MAIOR QUE OU IGUAL |
lt | MENOR QUE |
in | INSERIDO EM |
nin | NÃO INSERIDO EM |
isnull | NULO |
isnotnull | NÃO NULO |
Exemplos:
eq: fieldName:eq:value
neq: fieldName:neq:value
gt: fieldName:gt:value
gte: fieldName:gte:value
lt: fieldName:lt:value
lte: fieldName:lte:value
in: fieldName:in:value,value,value
nin: fieldName:nin:value,value,value
isnull: fieldName:isnull
isnotnull: fieldName:isnotnull
FieldNames
Abaixo estão as rotas e campos possíveis para a aplicação dos filtros e ordenação (filters e sort).
filters = [offer, credDate, tradeName, docNumber]sort = [tradeName]
filters = [stonecode]