Embalagens

O endpoint PostAddPackage é responsável pelo cadastro de uma nova embalagem no sistema MIMS. Esse cadastro pode ser visualizado na tela CAD016.

Como cadastrar uma embalagem

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	`{{url_base}}/PostAddPackage`
Exemplo	`http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPackage"`

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
PackageNo	String(25)	Sim	Código externo da embalagem
PackageName	String(40)	Sim	Descrição da embalagem
ShortName	String(15)	Sim	Descrição resumida da embalagem
UnitMeasurement	String(2)	Sim	Unidade de medida da embalagem
PackageTypeNo	String(25)	Sim	Código externo do tipo de embalagem
PackageClassification	PackageClassification	Sim	Enumerador com os possíveis valores para a Classificação/Espécie da Embalagem: `pcNotAssigned` (Não Atribuído), `pcPackaging` (Embalagem), `pcBag` (Bolsa), `pcBasePackaging` (Embalagem Base), `pcPallet` (Palete) ou `pcCage` (Gaiola)
Tare	Float	Não	Tara da embalagem
TareUnitMeasurement	String(2)	Sim	Unidade de medida da tara da embalagem
PackageLength	Float	Não	Comprimento da embalagem
PackageHeight	Float	Não	Altura da embalagem
PackageWidth	Float	Não	Largura da embalagem
DimensionUnitMeasurement	String(2)	Sim	Unidade de medida das dimensões da embalagem
PackageMeasurementList	PackageMeasurementList	Não	Objeto com as informações das Medidas da Embalagem
PackageVariationList	PackageVariationList	Não	Objeto com as informações das Variações da Embalagem
IsActive	Boolean	Não	Flag que indica se a embalagem está ativa ou não
OverwriteIfExists	Boolean	Não	Flag para sobrescrever caso a embalagem já exista

Observação

O parâmetro PackageTypeNo, quando a requisição for uma alteração da embalagem e o valor informado for igual ao texto de integração padrão (informação definida na variável "PadraoIntegracao" na chave "GERAL" do INI), o sistema não atualiza o valor desse campo. Nesse caso, o valor já existente no cadastro da embalagem será mantido.

📝 Objeto PackageMeasurementList

O objeto PackageMeasurementList representa uma lista das informações das Medidas da Embalagem.

Parâmetros de Entrada

Parâmetros Tipo Obrigatório Descrição
BranchNo String(25) Sim Código externo da filial
Tare Float Sim Tara da embalagem
PackageMeasurementValue Float Não Valor da embalagem
PackageMeasurementNotes String(2000) Não Observações referentes às medidas da embalagem
IsControlled Boolean Não Flag que indica se a embalagem é controlada ou não

Parâmetros	Tipo	Obrigatório	Descrição
BranchNo	String(25)	Sim	Código externo da filial
Tare	Float	Sim	Tara da embalagem
PackageMeasurementValue	Float	Não	Valor da embalagem
PackageMeasurementNotes	String(2000)	Não	Observações referentes às medidas da embalagem
IsControlled	Boolean	Não	Flag que indica se a embalagem é controlada ou não

📝 Objeto PackageVariationList

O objeto PackageVariationList representa uma lista das informações das Variações da Embalagem.

Parâmetros de Entrada

Parâmetro Tipo Obrigatório Descrição
PackageVariationNo String(15) Sim Código externo da variação
VariationName String(40) Sim Descrição da variação da embalagem
IdentificationCode Integer Sim Código de identificação
PackageVariationClassification PackageClassification Não Enumerador com os possíveis valores para a Classificação/Espécie da Embalagem: pcNotAssigned (Não Atribuído), pcPackaging (Embalagem), pcBag (Bolsa), pcBasePackaging (Embalagem Base), pcPallet (Palete) ou pcCage (Gaiola)
Tare Float Sim Tara da variação da embalagem
TareUnitMeasurement String(2) Sim Unidade de medida da tara da variação da embalagem
VariationLength Float Sim Comprimento da variação da embalagem
VariationHeight Float Sim Altura da variação da embalagem
VariationWidth Float Sim Largura da variação da embalagem
DimensionUnitMeasurement String(2) Sim Unidade de medida das dimensões da variação da embalagem
ReweighOverToleranceWeight Float Não Peso acima de tolerância em repesagens
ReweighUnderToleranceWeight Float Não Peso abaixo de tolerância em repesagens
ReweighOverTolerancePercentage Float Não Percentual acima de tolerância em repesagens
ReweighUnderTolerancePercentage Float Não Percentual abaixo de tolerância em repesagens
IsStandardVariation Boolean Não Flag que indica se esta variação é a variação padrão da embalagem
IsFinalVariation Boolean Não Flag que indica se esta variação é a variação final em manutenções de troca de variações

Parâmetro	Tipo	Obrigatório	Descrição
PackageVariationNo	String(15)	Sim	Código externo da variação
VariationName	String(40)	Sim	Descrição da variação da embalagem
IdentificationCode	Integer	Sim	Código de identificação
PackageVariationClassification	PackageClassification	Não	Enumerador com os possíveis valores para a Classificação/Espécie da Embalagem: `pcNotAssigned` (Não Atribuído), `pcPackaging` (Embalagem), `pcBag` (Bolsa), `pcBasePackaging` (Embalagem Base), `pcPallet` (Palete) ou `pcCage` (Gaiola)
Tare	Float	Sim	Tara da variação da embalagem
TareUnitMeasurement	String(2)	Sim	Unidade de medida da tara da variação da embalagem
VariationLength	Float	Sim	Comprimento da variação da embalagem
VariationHeight	Float	Sim	Altura da variação da embalagem
VariationWidth	Float	Sim	Largura da variação da embalagem
DimensionUnitMeasurement	String(2)	Sim	Unidade de medida das dimensões da variação da embalagem
ReweighOverToleranceWeight	Float	Não	Peso acima de tolerância em repesagens
ReweighUnderToleranceWeight	Float	Não	Peso abaixo de tolerância em repesagens
ReweighOverTolerancePercentage	Float	Não	Percentual acima de tolerância em repesagens
ReweighUnderTolerancePercentage	Float	Não	Percentual abaixo de tolerância em repesagens
IsStandardVariation	Boolean	Não	Flag que indica se esta variação é a variação padrão da embalagem
IsFinalVariation	Boolean	Não	Flag que indica se esta variação é a variação final em manutenções de troca de variações

Observação

Se ReweighOverToleranceWeight for informado, é necessário informar também o ReweighUnderToleranceWeight, e vice-versa.
Se ReweighOverTolerancePercentage for informado, é necessário informar também o ReweighUnderTolerancePercentage, e vice-versa.

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
PackageCode	Integer	Sim	Código interno da Embalagem gerado no sistema MIMS

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPackage"' \
--header 'Content-Type: application/json' \
--data '{
  "PackageNo": "PKG-001-2025",
  "PackageName": "Embalagem Padrão",
  "ShortName": "Caixa P",
  "UnitMeasurement": "UN",
  "PackageTypeNo": "TIPOEMBA1",
  "PackageClassification": "pcBasePackaging",
  "Tare": 2.5,
  "TareUnitMeasurement": "KG",
    "PackageLength": 30.0,
    "PackageHeight": 20.0,
    "PackageWidth": 15.0,
  "DimensionUnitMeasurement": "UN",
  "IsActive": true,
  "PackageMeasurementList": [
    {
      "BranchNo": "101",
      "Tare": 2.5,
      "PackageMeasurementValue": 100.0,
      "PackageMeasurementNotes": "Medição padrão P",
      "IsControlled": false
    }
  ],
  "PackageVariationList": [
    {
      "PackageVariationNo": "PKG-001-V1",
      "VariationName": "Variação Standard",
      "IdentificationCode": 1333,
      "PackageVariationClassification": "pcBasePackaging",
      "Tare": 3.5,
      "TareUnitMeasurement": "KG",
      "VariationLength": 31.0,
      "VariationHeight": 21.0,
      "VariationWidth": 16.0,
      "DimensionUnitMeasurement": "UN",
            "ReweighOverToleranceWeight": 0.10,
            "ReweighUnderToleranceWeight": 0.05,
            "ReweighOverTolerancePercentage": 2.0,
            "ReweighUnderTolerancePercentage": 2.0,
      "IsStandardVariation": true,
      "IsFinalVariation": false
    }
  ],  
  "OverwriteIfExists": false
}'

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "PackageCode": 26
}

🐞 Possíveis Erros

Código	Mensagem
APK‑001	A embalagem "PackageNo" informada já existe!
APK‑002	Existem variações de embalagem cuja classificação não corresponde à classificação informada ([valor enviado na requisição]) para a embalagem!
APK‑003	A classificação informada para esta embalagem ([valor enviado na requisição]) difere da classificação da variação existente!
APK‑004	Se o parâmetro "ReweighOverToleranceWeight" for informado, o parâmetro "ReweighUnderToleranceWeight" também deve ser informado, e vice-versa!
APK‑005	Se o parâmetro "ReweighOverTolerancePercentage" for informado, o parâmetro "ReweighUnderTolerancePercentage" também deve ser informado, e vice-versa!
APK‑006	Esta embalagem já foi utilizada na paletização. Não é permitido alterar a classificação previamente definida (pcPallet)!
APK‑007	Esta embalagem está vinculada ao produto ([código de produção do produto]), que está ativo. A embalagem não pode ser definida como inativa!
APK‑008	O código de identificação ([valor enviado na requisição]) informado no parâmetro IdentificationCode no índice [[código do índice]] já está associado a outro pacote!

Como cadastrar uma embalagem​

Parâmetros de Entrada​

📝 Objeto PackageMeasurementList​

Parâmetros de Entrada​

📝 Objeto PackageVariationList​

Parâmetros de Entrada​

Retorno​

Exemplo de Request​

Exemplo de Response​

🐞 Possíveis Erros​

Como cadastrar uma embalagem

Parâmetros de Entrada

📝 Objeto PackageMeasurementList

Parâmetros de Entrada

📝 Objeto PackageVariationList

Parâmetros de Entrada

Retorno

Exemplo de Request

Exemplo de Response

🐞 Possíveis Erros