Este método é responsável pela criação de novos Classificação produto
- Endpoint: /api/retaguarda/v2/classificacoesproduto
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Classificação produto para que possam ser enviados vários na mesma requisição
Para que a baixa da Classificação criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 11 = ClassificacaoProduto
Requisição
Exemplo de body da requisição
[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaPai": "string",
"loteOrigem": "string",
"nome": "string",
"sigla": "string",
"situacao": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
descricao |
string |
Descrição da classificação |
Sim |
Tamanho máximo: 100 caracteres |
| idInquilino | string | Identificador do inquilino | Sim | |
| idProprietario | string | Identificador do proprietário | Sim | |
| idRetaguarda | string | Identificador do imposto na retaguarda | Sim | Tamanho máximo: 100 caracteres |
| idRetaguardaPai | string | Identificador na retaguar da classificação pai | Não | Tamanho máximo: 100 caracteres |
| loteOrigem | string | Identificador do lote para envio dos dados | Sim | |
| nome | string | Nome da classificação | Sim |
Tamanho máximo: 50 caracteres |
| sigla | string | Sigla da classificação | Não |
Tamanho máximo: 50 caracteres |
| situacao | int | Situação da classificação | Sim | 0 - Inativo, 1 - Ativo |
Retorno
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
| Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
| Data | objeto | Objeto compartilhamento criado |
| Errors | Lista | Listas com os erros encontrados no processo |
| TotalTime | int | tempo da requisição |
| NumberOfRecords | int | número de dados inseridos |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| code | string | Código de erro |
| message | string | Mensagem do erro |
| detailedMessage | string | Detalhamento do erro |
| helpUrl | string | url de ajuda |
| TotalTime | string | Tempo total de busca |
| details | lista de objeto | Lista de objeto de erros |
| details.guid | string | Identificador do erro |
| details.code | string | Código do erro |
| details.message | string | Mensagem do erro |
| details.detailedMessage | string | Detalhamento do erro |
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.
Requisição
Exemplo de body da requisição
[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaPai": "string",
"loteOrigem": "string",
"nome": "string",
"sigla": "string",
"situacao": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
| descricao | string | Descrição da classificação | Sim |
Tamanho máximo: 100 caracteres |
| nome | string | Nome da classificação | Sim |
Tamanho máximo: 50 caracteres |
| sigla | string | Sigla da classificação | Não |
Tamanho máximo: 50 caracteres |
| idRetaguardaPai | string | Identificador na retaguarda classificação pai | Não | |
| situacao | int | Situação da classificação | Sim | 0 - Inativo, 1 - Ativo |
| idInquilino | string | Identificador do inquilino | Sim | |
| idRetaguarda | string | Identificador da classificação na retaguarda | Sim | |
| idProprietario | string | Identificador do proprietário | Sim | |
| loteOrigem | string | Identificador do lote para envio dos dados | Sim |
Retornos
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
| Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
| Data | objeto | Objeto compartilhamento criado |
| Errors | Lista | Listas com os erros encontrados no processo |
| TotalTime | int | tempo da requisição |
| NumberOfRecords | int | número de dados inseridos |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
Tipo |
Descrição |
|---|---|---|
| code | string | Código de erro |
| message | string | Mensagem do erro |
| detailedMessage | string | Detalhamento do erro |
| helpUrl | string | url de ajuda |
| TotalTime | string | Tempo total de busca |
| details | lista de objeto | Lista de objeto de erros |
| details.guid | string | Identificador do erro |
| details.code | string | Código do erro |
| details.message | string | Mensagem do erro |
| details.detailedMessage | string | Detalhamento do erro |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas