/
Product Object
Document toolboxDocument toolbox

Product Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 07, 2024 by Jason Andrew


On this page:

Product Object Formats

JSON Formt 
{
	"AllowedShipToLocations": [],
    "Deleted": false,
	"Desc": {
		"en": ""
	},
	"GeneralIncomeAccount": "",
	"IsBatch": false,
	"IsInvCtrl": false,
	"IsOffline": true,
	"IsSerialized": false,
	"Mfg": "",
	"ModelNum": "",
	"NonDiscountable": false,
	"NonTaxable": false,
	"Price": {
		"en": 0
	},
	"ProdNum": "",
	"ProdSubType": "",
	"ProdType": "",
	"Tags": [],
	"UPCUnitCode": ""
}

Product Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
Deletedboolean

Identifies if the product is to be deleted.

(info) This property is only used in conjunction with the bulk REST APIs

DesccollectionThis collection contains a list of localized descriptions for the product. Each entry in the collection contains a key/value pair combination. The key identifies the language code (see: Language Culture Codes) and the value refers to the localized description for the language.
GeneralIncomeAccountstring

Identifies General Income Account for the product. This property will store information which will be used in preparation of the company's financial statements.

Valid values are:

Codes

Activity CodeReservedDescription
1001Yes

General Income

3.19.0

IsBatchboolean

Identifies is the product is batch controlled. If true, then a batch number will be required to be entered on the mobile application any time this item is used.

Valid values are:

  • true - The product is batch controlled.
  • false - The product is not batch controlled. This is the default value if this property is missing.
IsInvCtrlboolean

Identifies if this product is under inventory control. If true, then the mobile application will automatically adjust the vehicle inventory for any usage of this item.

Valid values are:

  • true - The product is under inventory control.
  • false - The product is not under inventory control. This is the default value if this property is missing.
IsOfflineboolean

Identifies if this product should be part of the mobile application's offline catalog. If true, then this part will be available in any searches while the device is out of network coverage. If false, then the product will only show up in mobile searches while the device has a network connection.

Valid values are:

  • true - The product will be stored for offline use. This is the default value if this property is missing.
  • false - The product is not stored offline.
IsSerializedboolean

Identifies if the product is serialized or not. If true, then a serial number will be required to be entered on the mobile application any time this item is used.

Valid values are:

  • true - The product is serialized.
  • false - The product is not serialized. This is the default value if this property is missing.
MfgstringIdentifies the manufacturer of the product.
ModelNumstringIdentifies the manufacturer's model number for the product.
NonTaxableboolean

Indicates whether the product is exempt from tax collection

Valid values are:

  • true - The product is exempt from tax collection.
  • false - The product is taxable. This is the default value if this property is missing.

3.30.0

ProdNumstringIdentifies the unique product number.
ProdSubTypestring(info) Future
ProdTypestring

Identifies the product type or category.

See: Product Types

Pricedecimal

Identifies the price of the product. The price property's value was changed in release 3.16.0 to support either be a single decimal value (which is how the data is sent to the mobile device) or an object with prices for each supported country code.

UPCUnitCodestringIdentifies the UPC of the product.

Related content