...
Método de consulta de grupos de promoções cadastradas no ERP.
GET [URLAPI]/PromocaoAPI/api/v1/GrupoPromocao
Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.
Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Promoções > API Promoções Normais do ERP
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
SeqGrupoPromoc | Código para filtrar um grupo específico. | integer($int32) | Opcional |
Descricao | Para filtrar grupos com descrição específica. | string | Opcional |
DtaHoraAlteracao | Filtro para buscar grupos alterados a partir de uma data e hora. | string($date-time) | Opcional |
Fields | Campos | string | Não há |
Order | Ordenação | string | Não há |
Page | Página | integer($int32) | Não há |
PageSize | Tamanho da Página | integer($int32) | Não há |
...
CODE 200 - SUCCESS
GrupoPromocaoDtoIListDto
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
seqGrupoPromoc | Código do grupo cadastrado. | integer($int32) | Não há. |
descricao | Descrição do grupo cadastrado. | string | Não há. |
dtaHoraAlteracao | Data/Hora de alteração do grupo. | string($date-time) | Não há. |
indGeraAbastAuto | Indica que o grupo será utilizado como filtro no processo de Abastecimento Automático, no módulo Compras. | string | Não há. |
indPromocaoConcorrente | Indica que se trata de promoção para ações de concorrência. | string | Não há. |
expandables | Propriedade de expandir os campos. | string | Não há. |
Bloco de código | ||
---|---|---|
| ||
{ "hasNext": true, "items": [ { "seqGrupoPromoc": 0, "descricao": "string", "dtaHoraAlteracao": "2020-12-14T19:24:28.902Z", "indGeraAbastAuto": "string", "indPromocaoConcorrente": "string", "expandables": [ "string" ] } ] } |
application/json, text/json
CODE 400 - BAD
Bloco de código | ||
---|---|---|
| ||
{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "notificationType": 0, "code": "string", "message": "string", "detailedMessage": "string", "status": 0 } ] } |