Newer Version Available

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

ProductTransfer

Represents the transfer or the movement of a product item 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 Details
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the product transfer.
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
The date when the product is expected to be picked up.
IsReceived
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies if the product was received (true) or not (false).
IsProduct2Serialized
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether the product associated with the product transfer is a serialized product (true) or not (false).
The default value is false.
IsReceived
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the product was received (true) or not (false).
The default value is false.
IsSent
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the product was sent as a part of the transfer (true) or not (false).
The default value is false.
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 is not 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 product transfer.
This field 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
The product that’s associated with the product transfer.
This field is a relationship field.
Relationship Name
Product2
Relationship Type
Lookup
Refers To
Product2
Product2TransferRecordMode
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
If serialized, specifies 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
The product request that’s associated with the product transfer
This field is a relationship field.
Relationship Name
ProductRequest
Relationship Type
Lookup
Refers To
ProductRequest
ProductRequestLineItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The product request line item associated with the product transfer.
This field 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-generated number that identifies the product transfer.
QuantityReceived
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The quantity of product received at the destination location.
QuantitySent
Type
double
Properties
Create, Filter, Sort, Update
Description
The quantity 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.
Possible values are:
  • Each
ReceivedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The person that receives the product at the destination location.
This field 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 field 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 field is a relationship field.
Relationship Name
ReturnOrderLineItem
Relationship Type
Lookup
Refers To
ReturnOrderLineItem
ShipmentExpectedDeliveryDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the shipment is expected at the product transfer shipment.
ShipmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The shipment associated with the product transfer.
This field is a relationship field.
Relationship Name
Shipment
Relationship Type
Lookup
Refers To
Shipment
ShipmentStatus
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The status of the shipment associated with the product transfer.
ShipmentTrackingNumber
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The number of the shipment associated with the product transfer.
ShipmentTrackingUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
The tracking URL of the shipment associated with the product transfer.
SourceLocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source location associated with the product transfer.
This field is a relationship field.
Relationship Name
SourceLocation
Relationship Type
Lookup
Refers To
Location
SourceProductItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The product item associated with the product transfer.
This field is a relationship field.
Relationship Name
SourceProductItem
Relationship Type
Lookup
Refers To
ProductItem
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The status of the product transfer.