Newer Version Available

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

ProductTransfer

Represents the transfer of inventory between locations in field service.

Supported Calls

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

Special Access Rules

Field Service must be enabled.

Fields

Field Name Details
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
ExpectedPickupDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Date the product is expected to be picked up.
IsReceived
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Checkbox identifying that the product was received.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the product request was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the product request was last viewed.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Owner of the product transfer.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Product2Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup field for the product associated with the product transfer.
This is a relationship field.
Relationship Name
Product2
Relationship Type
Lookup
Refers To
Product2
Product2TransferRecordMode
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
If serialized, indicates when the serial number is recorded. It is visible on the product transfer as a read-only field depending on the field-level security. Possible values are:
  • SendAndReceive —The serial number is recorded when sending or receiving.
  • ReceiveOnly —The serial number is recorded when receiving only.
Relationship Name
Product2.TransferRecordMode
Relationship Type
Lookup
Refers To
Product2.TransferRecordMode
ProductRequestId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Lookup field for the product request associated with the product transfer.
This is a relationship field.
Relationship Name
ProductRequest
Relationship Type
Lookup
Refers To
ProductRequest
ProductRequestLineItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup field for the product request line item associated with the product transfer.
This is a relationship field.
Relationship Name
ProductRequestLineItem
Relationship Type
Lookup
Refers To
ProductRequestLineItem
ProductTransferNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An auto-assigned number that identifies the product transfer.
QuantityReceived
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Amount of product received at the destination location.
QuantitySent
Type
double
Properties
Create, Filter, Sort, Update
Description
Amount of product sent from the source location.
QuantityUnitOfMeasure
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The units of the product, for example grams, liters, or units.
ReceivedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup field for the contact who received the product at the destination location.
This is a polymorphic relationship field.
Relationship Name
ReceivedBy
Relationship Type
Lookup
Refers To
Group, User
ReturnOrderId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The return order associated with the product transfer.
This is a relationship field.
Relationship Name
ReturnOrder
Relationship Type
Lookup
Refers To
ReturnOrder
ReturnOrderLineItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The return order line item associated with the product transfer.
This is a relationship field.
Relationship Name
ReturnOrderLineItem
Relationship Type
Lookup
Refers To
ReturnOrderLineItem
ShipmentExpectedDeliveryDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Lookup field for the shipment related to the product transfer.
ShipmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup field for the shipment related to the product transfer.
This is a relationship field.
Relationship Name
Shipment
Relationship Type
Lookup
Refers To
Shipment
ShipmentStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Lookup field for the shipment related to the product transfer.
ShipmentTrackingNumber
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Lookup field for the shipment related to the product transfer.
ShipmentTrackingUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
Lookup field for the shipment related to the product transfer.
SourceLocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup field for the source location related to the product transfer.
This is a relationship field.
Relationship Name
SourceLocation
Relationship Type
Lookup
Refers To
Location
SourceProductItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Lookup field for the product item related to the product transfer.
Relationship Name
SourceProductItem
Relationship Type
Lookup
Refers To
ProductItem
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Status of the product transfer.

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.

ProductTransferChangeEvent (API version 48.0)
Change events are available for the object.
ProductTransferFeed
Feed tracking is available for the object.
ProductTransferHistory
History is available for tracked fields of the object.
ProductTransferOwnerSharingRule
Sharing rules are available for the object.
ProductTransferShare
Sharing is available for the object.