Shipment

Represents the transport of inventory in field service.

Supported Calls

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

Special Access Rules

Field Service Lightning must be enabled.

Fields

Field Name	Details
ActualDeliveryDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product was delivered.
DeliveredToId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The person or entity the product was delivered to.
Description	Type textarea Properties Create, Nillable, Update Description Details not recorded in the provided fields
DestinationLocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The place the product is to be delivered.
ExpectedDeliveryDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product is expected to be delivered.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shipment.
Provider	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The company or person making the transfer.
ShipFromAddress	Type address Properties Filter, Nillable Description The place the product is coming from.
ShipFromCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the shipment originates.
ShipFromCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the shipment originates.
ShipFromGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the shipment originates. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only. Note
ShipFromLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only. Note
ShipFromLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only. Note
ShipFromPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the shipment originates.
ShipFromState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the shipment originates.
ShipFromStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the address where the shipment originates.
ShipToAddress	Type address Properties Filter, Nillable Description The physical address where the shipment is delivered.
ShipToCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The city of the address where the shipment is delivered.
ShipToCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The country of the address where the shipment is delivered.
ShipToGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy level of the geocode for the address where the shipment is delivered. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only. Note
ShipToLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Longitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only. Note
ShipToLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with Latitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only. Note
ShipToName	Type string Properties Create, Filter, Group, Sort, Update Description The shipment recipient.
ShipToPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The postal code of the address where the shipment is delivered.
ShipToState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The state of the address where the shipment is delivered.
ShipToStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The street of the address where the shipment is delivered.
ShipmentNumber	Type string Properties Autonumber, Defaulted on create, Filter, Sort Description An auto-generated number identifying the shipment.
SourceLocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The field service location where the shipment originates.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the shipment. The picklist includes the following values, which can be customized: `Shipped`—The product is in transit. `Delivered`—The product is at the source location.
TrackingNumber	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Tracking number for the shipment.
TrackingUrl	Type url Properties Create, Filter, Group, Nillable, Sort, Update Description URL of website used for tracking the shipment.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ShipmentFeed: Feed tracking is available for the object.
ShipmentHistory: History is available for tracked fields of the object.
ShipmentOwnerSharingRule: Sharing rules are available for the object.
ShipmentShare: Sharing is available for the object.

Object Reference for Salesforce and Lightning Platform

Shipment

Supported Calls

Special Access Rules

Fields

Associated Objects