Adicionar Imagem do Produto - POST

Objetivo

Método que permite inserir as imagens dos produtos.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Produto/produto-imagem

Permissionamento

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 Cadastros Estruturais > API Cadastros Estruturais

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
idProdutoImagem	Identificador de Imagem para Produto	integer($int64)	Tamanho Máximo: 2147483647 Tamanho Mínimo: 0
idProduto*	Identificador do Produto no qual a imagem está relacionada	integer($int64)	Tamanho Máximo: 2147483647 Tamanho Mínimo: 0
descricao*	Descrição da Imagem	string	Tamanho Máximo: 40
imagem	Imagem	string	Não há.
urlEcommerceImg	Url Imagem E-commerce	string	Tamanho Máximo: 500
indPrincipal	Indicador se a imagem é a principal para o produto Valores: 'S' - Sim ou 'N' - Não	string	Tamanho Máximo: 1
dispImagem	Disposição da Imagem Valores: 'F' - Frente, 'V' - Verso ou 'L' - Lateral	string	Tamanho Máximo: 1
statusEcomm	Status da imagem para controle do E-commerce	string	Tamanho Máximo: 1

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "cgcFornecedor": 0,
  "tipoCodigo": "string",
  "idFamilia": 0,
  "qtdPorEmbalagem": 0,
  "idProduto": 0,
  "indUtilVenda": "string",
  "codigoAcesso": "string",
  "indPrefEdi": "string",
  "indEanTribNfe": "string",
  "usuarioAlteracao": "string"
}

application/json, text/json

CODE 400 - BAD

{
  "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
    }
  ]
}

Árvore de páginas