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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "associated_objects",
    "field_reference"
  ],
  "title": "BuyerGroupRelatedObject - Data API",
  "description": "Used to associate currencies and supported ship-to countries with a buyer group and its price books, promotions, and entitlements. Supports buyer experience when buyer group members shop in stores enabled for multiple locales. This object is available in API version 58.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "BuyerGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "ID of the buyer group this record is associated with. This field is a relationship field.",
      "relationship_name": "BuyerGroup",
      "relationship_type": "Lookup",
      "refers_to": "BuyerGroup",
      "required": true
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record."
    },
    "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, and LastReferenceDate is not null, the user accessed this record or list view indirectly.."
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "Name of this record."
    },
    "ObjectType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The names displayed in the picklist showing the ObjectValues - currency and ship-to countries. Possible values are: DefaultCurrency - Default Currency SupportedShipToCountries - Supported Ship-to Countries",
      "required": true
    },
    "ObjectValues": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Optional. Values for ObjectType. The actual currency and supported ship-to countries. Possible values are: Three-letter ISO currency code associated with the buyer account or a supported locale. ISO country code for supported ship-to countries."
    }
  },
  "special_access_rules": "BuyerGroupRelatedObject is availble only if the org is Market Enabled (Commerce.orgHasCommerceMarketEnabled).",
  "usage": "BuyerGroupRelatedObject is related to objects that enable a localized buyer experience. Together, these objects provide buyers with dynamic access to the qualifiers (entitlements, price books, and promotions) associated with their buyer group when they browse and shop in webstores with localized languages and currencies. The related objects are as follows:",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **BuyerGroupRelatedObjectChangeEvent**: Change events are available for the object.\n- **BuyerGroupRelatedObjectFeed**: Feed tracking is available for the object.\n- **BuyerGroupRelatedObjectHistory**: History is available for tracked fields of the object.",
  "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 Related Object 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": "Buyer Group Related Object Name",
      "type": "string",
      "length": "255"
    },
    "ObjectType": {
      "field_label": "Object Type",
      "type": "picklist",
      "length": "255"
    },
    "ObjectValues": {
      "field_label": "Object Values",
      "type": "textarea",
      "length": "2000"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}