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

119 lines
3.9 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",
"usage",
"associated_objects",
"field_reference"
],
"title": "PromotionTier - Data API",
"description": "Represents a tier of a promotion that includes multiple tiers. A promotion can have up to 10 tiers. This object is available in API version 57.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
},
"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, it can mean that the user accessed this record or list view (LastReferencedDate) but didnt view it."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Name of the promotion tier."
},
"PromotionId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID of the promotion associated with the promotion tier. This field is a relationship field.",
"relationship_name": "Promotion",
"relationship_type": "Lookup",
"refers_to": "Promotion"
},
"Rank": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Priority of the tier among the associated promotions tiers. Tiers are evaluated in order from lowest to highest rank. Each tier in a promotion must have a unique rank."
}
},
"usage": "Use promotion tiers with promotion qualifiers and promotion targets to create tiered promotions. Instead of associating one promotion qualifier and one promotion target with each promotion, associate one promotion qualifier and one promotion target with each promotion tier.",
"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- **PromotionTierFeed**: Feed tracking is available for the object.\n- **PromotionTierHistory**: History is available for tracked fields of 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"
},
"Id": {
"field_label": "Promotion Tier 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"
},
"Name": {
"field_label": "Promotion Tier Name",
"type": "string",
"length": "255"
},
"PromotionId": {
"field_label": "Promotion ID",
"type": "reference",
"length": "18"
},
"Rank": {
"field_label": "Rank",
"type": "int",
"digits": "9"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}