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

172 lines
5.7 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "OrderDeliveryMethod - Data API",
"description": "Shows the customizations and options that a buyer selected for their delivery method. This object is available in API version 48.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Carrier": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The carrier that the buyer chose for their delivery method. Developers must add values to this field."
},
"ClassOfService": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The carrier class of service that the buyer chose for their delivery method. Developers must add values to this field."
},
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Description of the delivery method."
},
"IsActive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Assign new delivery groups to active delivery methods."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed a record related to this record."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Default name of this record.",
"required": true
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The user who owns an order delivery method record."
},
"ProductId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Optional. This product represents a delivery charge order product for a delivery using this delivery method. For example, you could create a product that represents an overnight express charge and assign it to an overnight express delivery method."
},
"ReferenceNumber": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Reference number for an external delivery method."
},
"ShippingCarrierMethod": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Optional. A specific shipping service provided by a shipping carrier, such as Ground, 2Day, and NextDay. Depends on the range of transit times available for each carrier."
}
},
"special_access_rules": "To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **OrderDeliveryMethodChangeEvent (API version 62.0)**: Change events are available for the object.",
"field_reference": {
"Carrier": {
"field_label": "Carrier",
"type": "picklist",
"length": "40"
},
"ClassOfService": {
"field_label": "Class of Service",
"type": "picklist",
"length": "40"
},
"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": "2000"
},
"Id": {
"field_label": "Order Delivery Method ID",
"type": "id",
"length": "18"
},
"IsActive": {
"field_label": "Is Active",
"type": "boolean"
},
"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"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ProductId": {
"field_label": "Product ID",
"type": "reference",
"length": "18"
},
"ReferenceNumber": {
"field_label": "Reference Number",
"type": "string",
"length": "255"
},
"ShippingCarrierMethodId": {
"field_label": "Shipping Carrier Method ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}