Shipment

Represents the transport of inventory in field service or a shipment of order items in Order Management.

Introduced in API version 40.0.

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

  • At least one of these features must be enabled:

    • Order Management
    • Field Service
    • B2B Commerce
    • Consumer Goods Cloud Retail Execution
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Date the product was delivered.

  • 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: polymorphic

  • Refers to: Queue, User

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The delivery method used for the shipment.
  • Relationship name: DeliveryMethod
  • Relationship type: relationship
  • Refers to: OrderDeliveryMethod
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Details not recorded in the provided fields

  • 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: relationship

  • Refers to: Location

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Date the product is expected to be delivered.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 48.0
  • Description: The fulfillment order that the shipment belongs to.
  • Relationship name: FulfillmentOrder
  • Relationship type: relationship
  • Refers to: FulfillmentOrder
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The order summary associated with the shipment.
  • Relationship name: OrderSummary
  • Relationship type: relationship
  • Refers to: OrderSummary
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The company or person making the transfer.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 53.0
  • Description: For a return Shipment, the associated ReturnOrder.
  • Relationship name: ReturnOrder
  • Relationship type: relationship
  • Refers to: ReturnOrder
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city of the address where the shipment originates.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country of the address where the shipment originates.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update

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

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

  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of the address where the shipment originates.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state of the address where the shipment originates.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street of the address where the shipment originates.
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city of the address where the shipment is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country of the address where the shipment is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update

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

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

  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The shipment recipient.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of the address where the shipment is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state of the address where the shipment is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street of the address where the shipment is delivered.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: An auto-generated number identifying the shipment.

  • 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: relationship

  • Refers to: Location

  • 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.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 51.0
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Tracking number for the shipment.
  • Type: url
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: URL of website used for tracking the shipment.

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.