REST Object Definitions Inventory Related Objects Product Object

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

Required properties are in bold.

Property Type Description

AllowedShipToLocations

collection

Identifies allowed shipping locations for an ordered item when closing the work order with Closed Complete status. Mobile application will use Ordered Parts Shipping Location as default value if this property is missing

See: REST System Categories Ordered Parts Shipping Location

4.14.0

Deleted

boolean

Identifies if the product is to be deleted.

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

Desc object This object 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.

GeneralIncomeAccount

string

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 Code	Reserved	Description
1001	Yes	General Income

3.19.0

IsBatch

boolean

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.

IsInvCtrl

boolean

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.

IsOffline

boolean

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.

IsSerialized

boolean

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.

Mfg string Identifies the manufacturer of the product.

ModelNum string Identifies the manufacturer's model number for the product.

NonDiscountable

boolean

Indicates whether the product is exempt from applicable discounts

Valid values are:

true - The product is exempt from discounts, concessions, service contracts, and warranties.
false - The product is discountable. This is the default value if this property is missing.

3.45.0

NonTaxable

boolean

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

ProdNum string Identifies the unique product number.

ProdSubType string Future

ProdType

string

Identifies the product type or category.

See: REST System Categories Product Types

Price

object

This object contains a list of localized price 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 price for each supported language.