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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "field_reference"
  ],
  "title": "BuyerGroupPricebook - Data API",
  "description": "Represents a buyer group price book used in Lightning B2B Commerce. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "BuyerGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the buyer group that the price book record is assigned to."
    },
    "IsActive": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Determines whether the BuyerGroupPricebook 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, it’s 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 Buyer Group Price Book record."
    },
    "Pricebook2Id": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The ID of the price book assigned to the buyer group."
    },
    "Priority": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The sequential priority used to determine the price of a product. This field is only available for web stores that use the Priority pricing strategy."
    }
  },
  "special_access_rules": "The BuyerGroupPricebook object is available only if the B2B Commerce license is enabled.",
  "usage": "Use the BuyerGroupPricebook object to assign a price book to a set of buyer users. Assigning a price book to a buyer group allows buyers within that buyer group to retrieve product prices from the price book. When a buyer has multiple price book assignments, including multiple prices for the same product, the store Pricing Strategy determines the price.",
  "field_reference": {
    "BuyerGroupId": {
      "field_label": "Buyer Group ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Buyer Group 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": "Buyer Group Price Book Name",
      "type": "string",
      "length": "255"
    },
    "Pricebook2Id": {
      "field_label": "Price Book ID",
      "type": "reference",
      "length": "18"
    },
    "Priority": {
      "field_label": "Priority",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}