mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
177 lines
9.8 KiB
JSON
177 lines
9.8 KiB
JSON
{
|
|
"sections": [
|
|
"title",
|
|
"description",
|
|
"fields",
|
|
"special_access_rules",
|
|
"associated_objects",
|
|
"wsdl_segment",
|
|
"field_reference"
|
|
],
|
|
"title": "ShipmentItem - Data API",
|
|
"description": "Represents an order item included in a shipment. This object is available in API version 51.0 and later.",
|
|
"fields_columns": [
|
|
"type",
|
|
"properties",
|
|
"description",
|
|
"relationship_name",
|
|
"relationship_type",
|
|
"refers_to"
|
|
],
|
|
"fields": {
|
|
"Description": {
|
|
"type": "string",
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
|
"description": "Description of the shipment item."
|
|
},
|
|
"ExpectedDeliveryDate": {
|
|
"type": "dateTime",
|
|
"properties": "Filter, Nillable, Sort",
|
|
"description": "Expected delivery date of the shipment that contains the shipment item."
|
|
},
|
|
"FulfillmentOrderLineItemId": {
|
|
"type": "reference",
|
|
"properties": "Filter, Nillable, Sort",
|
|
"description": "The FulfillmentOrderLineItem (fulfillment order product) corresponding to the shipment item."
|
|
},
|
|
"OrderItemSummaryId": {
|
|
"type": "reference",
|
|
"properties": "Filter, Nillable, Sort",
|
|
"description": "The OrderItemSummary (order product summary) corresponding to the shipment item."
|
|
},
|
|
"Product2Id": {
|
|
"type": "reference",
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
|
"description": "The product represented by the shipment item. This is a relationship field.",
|
|
"relationship_name": "Product2",
|
|
"relationship_type": "Lookup",
|
|
"refers_to": "Product2"
|
|
},
|
|
"Quantity": {
|
|
"type": "double",
|
|
"properties": "Create, Filter, Sort, Update",
|
|
"description": "The quantity of products represented by the shipment item."
|
|
},
|
|
"ReturnOrderLineItemId": {
|
|
"type": "reference",
|
|
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
|
"description": "For a return ShipmentItem, the associated ReturnOrderLineItem. This field is available in API version 53.0 and later."
|
|
},
|
|
"ShipmentId": {
|
|
"type": "reference",
|
|
"properties": "Create, Filter, Group, Sort",
|
|
"description": "(Master-Detail) The shipment that contains the shipment item. This is a relationship field.",
|
|
"relationship_name": "Shipment",
|
|
"relationship_type": "Lookup",
|
|
"refers_to": "Shipment"
|
|
},
|
|
"ShipmentItemNumber": {
|
|
"type": "string",
|
|
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
|
|
"description": "An auto-generated number identifying the shipment item."
|
|
},
|
|
"TrackingNumber": {
|
|
"type": "string",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "The tracking number of the shipment that contains the shipment item."
|
|
},
|
|
"TrackingUrl": {
|
|
"type": "url",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "The tracking URL of the shipment that contains the shipment item."
|
|
}
|
|
},
|
|
"special_access_rules": "At least one of these features must be enabled:\n\nOrder Management\n\nField Service\n\nB2B Commerce\n\nHealth Cloud Visit Inventory\n\nConsumer Goods Cloud Retail Execution",
|
|
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **ShipmentItemFeed**: Feed tracking is available for the object.\n- **ShipmentItemHistory**: History is available for tracked fields of 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<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<complexType name=\"ShipmentItem\">\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=\"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=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ExpectedDeliveryDate\" 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=\"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=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"Quantity\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"Shipment\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Shipment\"/>\n <element name=\"ShipmentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ShipmentItemNumber\" 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=\"TrackingNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TrackingUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\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": "string",
|
|
"length": "255"
|
|
},
|
|
"ExpectedDeliveryDate": {
|
|
"field_label": "Expected Delivery Date",
|
|
"type": "datetime"
|
|
},
|
|
"Id": {
|
|
"field_label": "Shipment Item ID",
|
|
"type": "id",
|
|
"length": "18"
|
|
},
|
|
"IsDeleted": {
|
|
"field_label": "Deleted",
|
|
"type": "boolean"
|
|
},
|
|
"LastModifiedById": {
|
|
"field_label": "Last Modified By ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"LastModifiedDate": {
|
|
"field_label": "Last Modified Date",
|
|
"type": "datetime"
|
|
},
|
|
"Product2Id": {
|
|
"field_label": "Product ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"Quantity": {
|
|
"field_label": "Quantity",
|
|
"type": "double",
|
|
"precision": "18",
|
|
"scale": "2"
|
|
},
|
|
"ReturnOrderLineItemId": {
|
|
"field_label": "Return Order Line Item ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"ShipmentId": {
|
|
"field_label": "Shipment ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"ShipmentItemNumber": {
|
|
"field_label": "Shipment Item Number",
|
|
"type": "string",
|
|
"length": "255"
|
|
},
|
|
"SystemModstamp": {
|
|
"field_label": "System Modstamp",
|
|
"type": "datetime"
|
|
},
|
|
"TrackingNumber": {
|
|
"field_label": "Tracking Number",
|
|
"type": "string",
|
|
"length": "255"
|
|
},
|
|
"TrackingUrl": {
|
|
"field_label": "Tracking URL",
|
|
"type": "url",
|
|
"length": "255"
|
|
}
|
|
},
|
|
"field_reference_columns": [
|
|
"field_label",
|
|
"type",
|
|
"length",
|
|
"precision",
|
|
"scale"
|
|
]
|
|
} |