Versions Compared

Old Version 17

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2


Product Object Formats

Include Page
_Product Object Formats
_Product Object Formats

Product Object Properties

(info)(info) Required properties are in bold.

PropertyTypeDescription
AllowedShipToLocationscollection

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

Status
title4.14.0

Deletedboolean

Identifies if the product is to be deleted.

(info)

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

Desc
object
collectionThis
object
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:

Include Page
_General Income Ledger Activity Codes
_General Income Ledger Activity Codes

Status
title3.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
.NonDiscountableboolean

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.
Statustitle3.45
.
0
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.

Status
title3.30.0

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

Identifies the product type or category.

See:

REST System Categories Statustitle3.33.0

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.

Tagscollection

This optional property specifies a collection of product group identifiers. Mobile application will utilize tags to group related products in a product catalog. The syntax of each item in the collection is:

<SubCatID>|<SysActID>

Pipe ('|') is a separator between SubCatID and SysActID.

See: Product Group Identifiers

decimal

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.