Parts Ordering Object

Parts Ordering Object Formats

JSON Format
{
    "AccountNum": "",
    "Command": 1001,
	"Location": {
        "Address": {
            "AddrLine1": "",
            "AddrLine2": "",
            "AddrLine3": "",
            "AddrLine4": "",
            "AddrType": "",
            "City": "",
            "Country": "",
            "Region": "",
            "Zip": ""
        },
        "Contacts": [{
            "Email": "",
            "FirstName": "",
            "IsPrimary": true,
            "LastName": "",
            "Phones": [{
                "PhoneNum": "",
                "PhoneType": ""
            }]
        }],
        "Email": "",
        "LanguageID": "",
        "LocationNum": "",
        "Name": "",
        "Notes": "",
        "POReq": false,
        "ServiceAreaID": "",
        "SigReq": true,
        "StorageLocationID": "",
        "WorkCenter": ""
    },
    "Parts": [
        {
            "ProdNum": "",
            "ProdAttrs": {
               "Desc": ""
            },
            "Qty": 10.0,
			"ShipToLocation": "",
			"Urgency": ""
        }
    ],
	"UserName": "",
    "WorkOrder": ""
}

Parts Ordering Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
AccountNumstring

Identifies the account number associated with the parts ordering request.

Commandinteger

Specifies the type of part ordering request being made.

Valid options are:

  • 1002 - Place order
Locationobject

The account location identifies the actual location (address) of where the part is required for service to be completed. For residential customers this is typically the same as the account information. However, there are cases such as in the auto insurance industry where this could be an auto body shop where a vehicle was towed after an accident. 

See: Account Location Object

3.34.0

Partscollection

This collection contains a list of parts that needs to be ordered. There will be one entry in the collection for each part.

PropertyTypeDescription
ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

ProdNumstringIdentifies the product number to be ordered.
Qtydecimal

Identifies the quantity being ordered.

ShipToLocationstring

Optional property that identifies the location where the ordered part will be shipped to.

3.18.0 3.37.0

Urgencystring

Optional property that identifies the location where the ordered part will be shipped to.

3.18.0 3.37.0

UserNamestring

This property identifies the ID of the mobile worker.

3.34.0

WorkOrderstringIdentifies the work order number associated with the parts ordering request.