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

118 lines
3.8 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"associated_objects",
"field_reference"
],
"title": "WebStorePricebook - Data API",
"description": "Represents a store price book used in Lightning B2B Commerce. This object is available in API version 48.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"IsActive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Determines whether the WebStorePricebook is active (true) or not (false). Default value is false."
},
"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, its possible that this record was referenced (LastReferencedDate) and not viewed."
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The name of the store price book record."
},
"Pricebook2Id": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The ID of the price book assigned to the store."
},
"WebStoreId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID of the store assigned to the price book."
}
},
"special_access_rules": "This object is available only if the B2B Commerce license is enabled.",
"usage": "Use the WebStorePricebook object to assign price books to a store. When you assign a price book to a web store, any buyer who has access to the store can price products from the assigned price books. When a store or buyer has multiple price book assignments, including prices to the same product, the price is determined by the pricing strategy of the store.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **WebStorePricebookFeed**: Feed tracking is available for this object.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Store Price Book 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": "Store Price Book Name",
"type": "string",
"length": "255"
},
"Pricebook2Id": {
"field_label": "Price Book ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"WebStoreId": {
"field_label": "Store ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}