CartItemRecipient

Each row represents a service site that receives products or services from a cart. Recipients are associated with specific service points that define the configuration and delivery terms for each site. The cart can be configured by one or more service points. This object is available in API version 68.0 and later.

Supported Calls

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

Fields

Field Details
DistributionArea
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the distribution area where service is available for the site.
Possible values are:
  • BirHigh366E
  • BirHigh366G
  • CovHigh365G
  • CovMed365E
  • EdHigh287E
  • EdHigh287G
  • ExeHigh187E
  • ExeMed187G
  • GlaMed288E
  • GlaMed288G
  • LOND, DERBY—LOND,DERBY
  • LonHigh909G
  • LonMed909E
  • NewcHigh367E
  • SouHigh188E
  • SouMed188G
EstimatedConsumption
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The estimated monthly consumption in units for the product or service delivered at the service point.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the cart item recipient.
RecipientType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of recipient for the cart item.
Possible values are:
  • Location
  • Site
  • Subscriber
The default value is Location.
ServiceAddress
Type
address
Properties
Filter
Description
The address where the recipient receives the service.
ServiceCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city where the recipient receives the service.
ServiceCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country where the recipient receives the service.
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 service.
ServiceLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The longitude of the location where the recipient receives the service.
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 service.
ServiceStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street where the recipient receives the service.
ServiceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of service delivered at the site.
Possible values are:
  • Electricity
  • Energy
  • Gas
  • Water
UnitOfMeasureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit of measure used to quantify and price the product or service for the recipient.
This field is a relationship field.
Relationship Name
UnitOfMeasure
Refers To
UnitOfMeasure
WebCartId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The parent object associated with the record.
This field is a relationship field.
Relationship Name
WebCart
Relationship Type
Master-detail
Refers To
WebCart (the master object)