afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ProductTransfer.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ProductTransfer - Data API",
  "description": "Represents the transfer of inventory between locations in field service.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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."
    }
  },
  "special_access_rules": "Field Service must be enabled.",
  "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.\n\n- **ProductTransferChangeEvent (API version 48.0)**: Change events are available for the object.\n- **ProductTransferFeed**: Feed tracking is available for the object.\n- **ProductTransferHistory**: History is available for tracked fields of the object.\n- **ProductTransferOwnerSharingRule**: Sharing rules are available for the object.\n- **ProductTransferShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"ProductTransfer\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Attachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DestinationLocation\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Location\"/>\n        <element name=\"DestinationLocationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ExpectedPickupDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsProduct2Serialized\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsReceived\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsSent\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"NotesAndAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Product2\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Product2\"/>\n        <element name=\"Product2Id\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Product2TransferRecordMode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProductItemTransactions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProductRequest\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ProductRequest\"/>\n        <element name=\"ProductRequestId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ProductRequestLineItem\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ProductRequestLineItem\"/>\n        <element name=\"ProductRequestLineItemId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ProductTransferNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProductTransferStates\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"QuantityReceived\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"QuantitySent\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"QuantityUnitOfMeasure\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ReceivedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ReceivedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ReturnOrder\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ReturnOrder\"/>\n        <element name=\"ReturnOrderId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ReturnOrderLineItem\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ReturnOrderLineItem\"/>\n        <element name=\"ReturnOrderLineItemId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"SerializedProductTransactions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Shipment\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Shipment\"/>\n        <element name=\"ShipmentExpectedDeliveryDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ShipmentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ShipmentStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ShipmentTrackingNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ShipmentTrackingUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SourceLocation\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Location\"/>\n        <element name=\"SourceLocationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"SourceProductItem\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ProductItem\"/>\n        <element name=\"SourceProductItemId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Tasks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"TopicAssignments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "32000"
    },
    "DestinationLocationId": {
      "field_label": "Destination Location ID",
      "type": "reference",
      "length": "18"
    },
    "ExpectedPickupDate": {
      "field_label": "Expected Pickup Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Product Transfer ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsProduct2Serialized": {
      "field_label": "Serialized",
      "type": "boolean"
    },
    "IsReceived": {
      "field_label": "Received",
      "type": "boolean"
    },
    "IsSent": {
      "field_label": "Sent",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "Product2Id": {
      "field_label": "Product ID",
      "type": "reference",
      "length": "18"
    },
    "Product2TransferRecordMode": {
      "field_label": "Transfer Record Mode",
      "type": "picklist",
      "length": "255"
    },
    "ProductRequestId": {
      "field_label": "Product Request ID",
      "type": "reference",
      "length": "18"
    },
    "ProductRequestLineItemId": {
      "field_label": "Product Request Line Item ID",
      "type": "reference",
      "length": "18"
    },
    "ProductTransferNumber": {
      "field_label": "Product Transfer Number",
      "type": "string",
      "length": "255"
    },
    "QuantityReceived": {
      "field_label": "Quantity Received",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "QuantitySent": {
      "field_label": "Quantity Sent",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "QuantityUnitOfMeasure": {
      "field_label": "Quantity Unit Of Measure",
      "type": "picklist",
      "length": "40"
    },
    "ReceivedById": {
      "field_label": "Received by ID",
      "type": "reference",
      "length": "18"
    },
    "ReturnOrderId": {
      "field_label": "Return Order ID",
      "type": "reference",
      "length": "18"
    },
    "ReturnOrderLineItemId": {
      "field_label": "Return Order Line Item ID",
      "type": "reference",
      "length": "18"
    },
    "ShipmentExpectedDeliveryDate": {
      "field_label": "Shipment Expected Delivery Date",
      "type": "datetime"
    },
    "ShipmentId": {
      "field_label": "Shipment ID",
      "type": "reference",
      "length": "18"
    },
    "ShipmentStatus": {
      "field_label": "Shipment Status",
      "type": "picklist",
      "length": "40"
    },
    "ShipmentTrackingNumber": {
      "field_label": "Shipment Tracking Number",
      "type": "string",
      "length": "255"
    },
    "ShipmentTrackingUrl": {
      "field_label": "Shipment Tracking URL",
      "type": "url",
      "length": "255"
    },
    "SourceLocationId": {
      "field_label": "Source Location ID",
      "type": "reference",
      "length": "18"
    },
    "SourceProductItemId": {
      "field_label": "Source Product Item ID",
      "type": "reference",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "40"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}