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 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.
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.
Note

Note

This field is available in the API only.

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.
Note

Note

This field is available in the API only.

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.
Note

Note

This field is available in the API only.

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.
Note

Note

This field is available in the API only.

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.
Note

Note

This field is available in the API only.

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.
Note

Note

This field is available in the API only.

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.