OrderItemRecipient

Represents a site, employee, or other entity for which services are being ordered. This includes essential details such as the recipient's name, contact information, and the specific site or location where the services will be provided. This object is available in API version 62.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field Details
BroadbandConnectionType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the broadband connection that's available at the address.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
MaxDownloadSpeed
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum download speed available at the address.
MaxUploadSpeed
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum upload speed available at the address.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the customer's site or location.
OrderId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The order associated with the recipient.
This field is a relationship field.
Relationship Name
Order
Relationship Type
Master-detail
Refers To
Order (the master object)
RecipientType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of recipient of the order.
Possible values are:
  • Location
  • Subscriber
The default value is Location.
ServiceAddrValidationDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the address was validated.
Service Account
Type
entityid
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the Account Entity where the product is used, serviced, or installed.
ServiceAddrValidationMsg
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The message sent after the validation of the address.
ServiceAddrValidationResult
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the address validation.
Possible values are:
  • Fail
  • Partial Success
  • Success
The default value is Success.
ServiceAddress
Type
address
Properties
Filter
Description
The address where the recipient receives the order.
ServiceCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city where the recipient receives the order.
ServiceCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country where the recipient receives the order.
ServiceGeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the accuracy level of the geocoded address coordinates.
Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip—Extended Zip
  • NearAddress—Near Address
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
ServiceLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The latitude of the location where the recipient receives the order.
ServiceLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The longitude of the location where the recipient receives the order.
ServicePostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code of the address.
ServiceState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state where the recipient receives the order.
ServiceStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street where the recipient receives the order
ServiceabilityCheckDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the serviceability check was done.
ServiceabilityData
Type
textarea
Properties
Create, Nillable, Update
Description
The information about serviciability, such as broadband connection, download, and upload speeds available at the address.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

OrderItemRecipientChangeEvent
Change events are available for the object.
OrderItemRecipientFeed
Feed tracking is available for the object.
OrderItemRecipientHistory
History is available for tracked fields of the object.
OrderItemRecipientOwnerSharingRule
Sharing rules are available for the object.
OrderItemRecipientShare
Sharing is available for the object.