Árvore de páginas

Objetivo

Método de inclusão das informações das embalagens de famílias.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia/embalagem

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)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

IdFamilia*

Identificador da famíliainteger($int64)Não há.
qtdPorEmbalagem*

Quantidade por Embalagem

number($double)Não há.
embalagem*

Sigla da embalagem. Ex: CX (Caixa)

stringNão há.
pesoBruto*Peso bruto da embalagem em KGnumber($double)Mínimo: 0
Máximo: 9999
pesoLiquido*Peso líquido da embalagem em KGnumber($double)Mínimo: 0
Máximo: 9999
altura*Altura da embalagem em centímetrosnumber($double)Mínimo: 0
Máximo: 9999
largura*Largura da embalagem em centímetrosnumber($double)Mínimo: 0
Máximo: 9999
profundidade*Profundidade da embalagem em centímetrosnumber($double)Mínimo: 0
Máximo: 9999
status*Status da embalagem. Valores: A (Ativo) e I (Inativo)stringNão há.
qtdUnidEmbalagem

Quantidade Unid.Embalagem

number($double)Mínimo: 0
Máximo: 9999
multEquipQtdEmbalagem

Multiplicador Equip. Quantidade Embalagem

number($double)Mínimo: 0
Máximo: 9999
fatorMultVolume

Fator Multiplicador do Volume

number($double)Mínimo: 0
Máximo: 9999
multEquipEmbalagem

Multiplicador Equip.Embalagem

stringNão há.
percToleranciaPesoPercentual de tolerância de pesonumber($double)Mínimo: 0
Máximo: 9999

Parâmetros do Corpo (Body Parameters)

Não há.

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

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idFamilia": 0,
      "idMarca": 0,
      "nomeFamilia": "string",
      "pesavel": "string",
      "indiceFormBaseIpi": 0,
      "aliquotaIpi": 0,
      "usuarioAlteracao": "string",
      "dtaHorAlteracao": "2020-10-27T14:53:33.193Z",
      "usuarioInclusao": "string",
      "dtaHorInclusao": "2020-10-27T14:53:33.193Z",
      "pmtDecimal": "string",
      "indCalcIpiSaida": "string",
      "perBaseIpi": 0,
      "perIsentoIpi": 0,
      "perOutroIpi": 0,
      "perAliquotaIpi": 0,
      "vlrIpiPauta": 0,
      "codTipi": 0,
      "indComplVlrImp": "string",
      "codNbmsh": "string",
      "situacaoNfPis": "string",
      "situacaoNfCofins": "string",
      "perBasePis": 0,
      "perBaseCofins": 0,
      "atualizNcmIpi": "string",
      "aliqPadraoIcms": 0,
      "codNatRec": 0,
      "situacaoNfPisSai": "string",
      "atualizaNcmImpImport": "string",
      "perImpostoImport": 0,
      "perRedImpostoImport": 0,
      "perRedBaseIpiEnt": 0,
      "seqNatRec": 0,
      "indBebidaAlcoolica": "string",
      "sitPisCofinsSimples": "string",
      "situacaoNfIpi": "string",
      "situacaoNfIpiSai": "string",
      "aliqPadraoIcmsProtege": 0,
      "indEscritOutrosEI": "string",
      "codProdDacAl": 0,
      "codNve": "string",
      "classeEnquadramentoIpi": "string",
      "codigoSeloIpi": "string",
      "codigoEnquadramentoIpi": "string",
      "litrosTabIpiPisCofins": 0,
      "codCest": 0,
      "indMaterialApoio": "string",
      "perTributadoInt": 0,
      "situacaoNfCofinsSai": "string",
      "familiaEmbalagem": [
        {
          "expandables": [
            "string"
          ],
          "idFamilia": 0,
          "qtdPorEmbalagem": 0,
          "embalagem": "string",
          "pesoBruto": 0,
          "pesoLiquido": 0,
          "altura": 0,
          "largura": 0,
          "profundidade": 0,
          "status": "string",
          "qtdUnidEmbalagem": 0,
          "multEquipQtdEmbalagem": 0,
          "fatorMultVolume": 0,
          "multEquipEmbalagem": "string",
          "percToleranciaPeso": 0
        }
      ],
      "informacaoNutricional": [
        {
          "idInformacaoNutricional": 0,
          "descricao": "string",
          "obsInfNutric": "string",
          "qtdPorcao": 0,
          "unidPorcao": "string",
          "intMedCaseira": "string",
          "decMedCaseira": "string",
          "medCaseira": "string",
          "tabelaNutricional": [
            {
              "idInformacaoNutricional": 0,
              "idAtributoFixo": 0,
              "descricaoQuantidadePorcao": "string",
              "percVlrDiaRef": 0
            }
          ]
        }
      ]
    }
  ]
}

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