Newer Version Available

This content describes an older version of this product. View Latest

Shipment

Represents a product item that’s in transit between two inventory locations. This object is available in API version 60.0 and later.

Supported Calls

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

Fields

Field Name Details
ActualDeliveryDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the product was delivered.
DeliveredToId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The person or entity the product was delivered to.
This is a polymorphic relationship field.
Relationship Name
DeliveredTo
Relationship Type
Lookup
Refers To
Group, User
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the shipment.
DestinationLocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The place the product is to be delivered.
This is a relationship field.
Relationship Name
DestinationLocation
Relationship Type
Lookup
Refers To
Location
ExpectedDeliveryDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when 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 indirectly, for example, through a list view or related record.
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, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the shipment.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ReturnOrderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The return order associated with a return shipment.
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.
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.
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.
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.
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.
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.
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, idLookup, Sort
Description
An auto-generated number identifying the shipment.
SourceLocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The location where the shipment originates.
This is a relationship field.
Relationship Name
SourceLocation
Relationship Type
Lookup
Refers To
Location
Status
Type
picklist
Properties
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.
TotalItemsQuantity
Type
double
Properties
Filter, Nillable, Sort
Description
The total quantity of items included in the shipment. This value is calculated as the sum of the quantities of the shipment items in the shipment.
TrackingNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The tracking number for the shipment.
TrackingUrl
Type
url
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The URL of the website used for tracking the shipment.