Versions Compared

Old Version 11

changes.mady.by.user Rahul Mehta

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.

The RequiredPart object contains part order details. The RequiredPart object is always used inside of another object such as the appointment search object, book job etc. 

RequiredPart Object Formats

Include Page
_OrderedPart Object Formats
_OrderedPart Object Formats

RequiredPart Object Properties

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

Property
Type
Description
EstimatedDeliverydatetime

This optional property specifies the estimate delivery date of the associated part.

This property is calculated and populated by the back end system if a connection is available at the time the part is ordered. Otherwise, this property will be left empty.

PartOrderNumstringThe order number associated with the part being ordered.
PartStatusstring

Specifies the status of ordered part. This is a simple free-form text field with no validation.

3.18.0

Pricedecimal

The price of the ordered part.

This property is set by the backend system if a network connection is available at the time the part is ordered. Otherwise, the mobile application will use the default price from the Product catalog.

ProdAttrsobject

This object contains the ordered part's product attributes from the Product table. If this object is not specified, then the Broker ESB will automatically populate it from the details in the Product table.

(info)

(info) If the Product table is not being managed through the Product REST APIs, then this object is required.

PropertyTypeDescription
DescstringProvides the description of the product item. This description will be in the preferred language of the technician.
IsBatchboolean

Identifies if this product item is batch controlled. If true, then the BatchNum property is required.

Valid values are:

  • true - Item is batch controlled.
  • false - Item 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 application will automatically adjust the proper storage location's inventory based on the item usage.

Valid values are:

  • true - Item is under inventory control.
  • false - Item is not under inventory control. This is the default value if this property is missing.
IsSerializedboolean

Identifies if this product item is serialized or not. If true, then the SerialNum property is required.

Valid values are:

  • true - Item is serialized and requires a serial number.
  • false - Item is not serialized. This is the default value if this property is missing.
ProdTypestring

Identifies the product item type or category.

See: Product Types System Category

 


See: Product Object

ProdNumstringThe product number of the ordered part.
QtydecimalThe quantity being ordered.
ShipToLocationstringThe location where the parts are to be shipped (see 
REST System Categories
Ordered Parts Shipping Location in system categories).
SupersededPartscollection

This optional collection contains a list of parts that replaces the ordered part.

Property
Type
Description
ProdNumstringThe product number of the replacement part.
PartStatusstring

Specifies the status of replacement part. This is a simple free-form text field with no validation.

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

QtydecimalThe quantity being ordered.

3.18.0

Urgencystring

This property identifies shipping urgency for the ordered part (see

REST System Categories

Ordered Parts Shipping Urgency in system categories).

Status
title3.18.1