--- schema_version: "1" id: c5289421ea01591d8cf16d3f5259bf040d5785731dbcd7097740552b34b21853 title: Shipment collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_shipment.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shipment.htm source_site: developer.salesforce.com content_type: documentation content_hash: c65efaeeb75fbfac65ed77fc9a1c99c74883a8677534fa810b132950a65341fe description: Represents the transport of inventory in field service or a shipment of order items in Order Management. --- # Shipment Represents the transport of inventory in field service or a shipment of order items in Order Management. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules At least one of these features must be enabled: - Order Management - Field Service - B2B Commerce - Consumer Goods Cloud Retail Execution ## 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. This is a polymorphic relationship field. Relationship Name DeliveredTo Relationship Type Lookup Refers To Group, User | | DeliveryMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The delivery method used for the shipment. This field is available in API version 51.0 and later. | | 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. This is a relationship field. Relationship Name DestinationLocation Relationship Type Lookup Refers To Location | | ExpectedDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date the product is expected to be delivered. | | FulfillmentOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The fulfillment order that the shipment belongs to. This field is available in API version 51.0 and later. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last interacted with this record, directly or indirectly. | | 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, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. | | OrderSummaryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order summary associated with the shipment. This field is available in API version 51.0 and later. | | 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 | | Provider | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The company or person making the transfer. | | ReturnOrderId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description For a return Shipment, the associated ReturnOrder. This field is available in API version 53.0 and later. | | ShipFromAddress | Type address Properties Filter, Nillable Description The place the product is coming from. The compound form of the ship to address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### 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. The compound form of the ship to address. Read-only. For details on compound address fields, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_address.htm "Standard addresses—addresses built into standard objects in Salesforce—are accessible in the SOAP API and REST API as an Address, a structured compound data type, as well as individual address elements. If you enabled Custom Address Fields, you can also add custom fields that mimic the standard address field behavior."). | | 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations "Address and geolocation compound fields are convenient and result in more concise, clear code. Here are some things to consider when using them in your apps.") for details on geolocation compound fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png) #### 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, idLookup, 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. 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: - Created—Shipment has been created. - Delivered—Shipment has been delivered. - In Transit—Shipment is in transit. - Shipped—Order has been shipped. - Voided—Shipment has been cancelled. | | 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. This field is available in API version 51.0 and later. | | 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. 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. [ShipmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 48.0) Change events are available for the object. [ShipmentFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ShipmentHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ShipmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ShipmentShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. #### See Also - [ShipmentItem](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shipmentitem.htm "Represents an order item included in a shipment. This object is available in API version 51.0 and later.")