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

147 lines
5.2 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "SalesChannel - Data API",
"description": "Represents the origin of an order. For example, a web storefront, physical store, marketplace, or mobile app. If you integrate Salesforce Order Management with Salesforce B2C Commerce, set up a SalesChannel corresponding to each Site in your B2C Commerce implementation. This object is available in API version 48.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Description of the SalesChannel."
},
"ExternalChannelNumber": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "External system identifier for the SalesChannel."
},
"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. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the user who currently owns this SalesChannel. Default value is the user logged in to the API to perform the create."
},
"SalesChannelName": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Name of the SalesChannel."
},
"Type": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Type of the SalesChannel. Each Type corresponds to one Type Category. You can customize the Type picklist to represent your business processes, but the Type Category picklist is fixed because some order processing is based on those values. If you customize the Type picklist, include at least one value for each Type Category. This field is available in API version 53.0 and later. Default values are: B2B B2C Other"
},
"TypeCategory": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Type Category of the SalesChannel. Each Type Category corresponds to one or more Types. This field isnt visible in the UI. This field is available in API version 53.0 and later. Possible values are: B2B B2C Other"
}
},
"special_access_rules": "This object is only available in Salesforce Order Management orgs.",
"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- **SalesChannelChangeEvent (API version 62.0)**: Change events are available for the object.\n- **SalesChannelShare(API version 66.0)**: Sharing is available for the object.",
"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": "2000"
},
"ExternalChannelNumber": {
"field_label": "External Channel Number",
"type": "string",
"length": "255"
},
"Id": {
"field_label": "Sales Channel 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"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"OrderManagementBillingType": {
"field_label": "Order Management Billing Type",
"type": "picklist",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SalesChannelName": {
"field_label": "Sales Channel Name",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Type": {
"field_label": "Type",
"type": "picklist",
"length": "40"
},
"TypeCategory": {
"field_label": "Type Category",
"type": "picklist",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}