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

120 lines
3.6 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "Wishlist - Data API",
"description": "Represents a buyer-created list of WishlistItems in a store thats built with B2B Commerce on Lightning. Available in API version 49.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"AccountId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The ID of the account that owns the Wishlist."
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The ISO code for the currency thats specified on the buyers account. Default value is USD. Possible values are: USD—U.S. Dollar"
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of this Wishlist record. Name can be up to 255 characters."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the user or group that owns the Wishlist."
},
"WebStoreId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The ID of the WebStore related to this Wishlist."
},
"WishlistProductCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The count of WishlistItems on this Wishlist. WishlistProductCount is a calculated field."
}
},
"special_access_rules": "The Wishlist object is available only if the B2B Commerce license is enabled.",
"associated_objects": "This object has the following associated objects. Unless its noted, associated objects are available in the same API version as this object.\n\n- **WishlistOwnerSharingRule**: Sharing rules are available for the object.\n- **WishlistShare**: Sharing is available for the object.",
"field_reference": {
"AccountId": {
"field_label": "Account ID",
"type": "reference",
"length": "18"
},
"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": "Wishlist 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"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"WebStoreId": {
"field_label": "Store ID",
"type": "reference",
"length": "18"
},
"WishlistProductCount": {
"field_label": "Unique Products in the Wishlist",
"type": "int",
"digits": "9"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}