saveProductPackage

Add a package option (eg. "a box of 12" or "a pallet of 2500") to a product, or modify an existing one.

In back office, packages are listed in the subsection Packages on product card.

To get a list of packages for a product (and their IDs, to be able to modify them), call API getProducts and specify flag getPackageInfo = 1.

To delete a package, see deleteProductPackage.

Input parameters

Parameter name Description Possible value Required
packageID  Package ID. Required if you want to edit an existing package.  Integer    
productID 

Product ID. Required if you want to add a new package.

Do not set this field if you are editing an existing package — error 1013 will be returned. A package cannot be "transfered" from one product to another; delete it and add a new one instead.

 
Integer    
packageTypeID  Package type ID, see API getProductPackageTypes. Required if you want to add a new package.  Integer    
packageAmount 

Amount that this package contains. Required if you want to add a new package.

Must be a positive decimal, otherwise error 1014 is returned.

 
Decimal    
packageCode 

Package barcode.

This is just an informative field at the moment. Neither back office nor POS allow to scan products by their package barcode. This field might be useful for third-party integrations, however.

 
String    
packageNetWeight 

Package weight without packing materials. (Back office specifies the unit of this field as "kg" or "lbs", depending on your account's country.)

Must be a positive decimal, zero, or empty string, otherwise error 1014 is returned.

 
Decimal    
packageGrossWeight 

Package total weight. (Back office specifies the unit of this field as "kg" or "lbs", depending on your account's country.)

Must be a positive decimal, zero, or empty string, otherwise error 1014 is returned.

 
Decimal    
packageLength 

Physical dimensions of the package. (Back office specifies the unit of this field as "mm" or "in", depending on your account's country.)

Must be a positive decimal, zero, or empty string, otherwise error 1014 is returned.

 
Decimal    
packageWidth 

Physical dimensions of the package. (Back office specifies the unit of this field as "mm" or "in", depending on your account's country.)

Must be a positive decimal, zero, or empty string, otherwise error 1014 is returned.

 
Decimal    
packageHeight 

Physical dimensions of the package. (Back office specifies the unit of this field as "mm" or "in", depending on your account's country.)

Must be a positive decimal, zero, or empty string, otherwise error 1014 is returned.

 
Decimal    

Response

Field name Type Description
packageID  Integer  ID of the added or modified record.