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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "PromotionSegmentSalesStore - Data API",
  "description": "Represents a promotion segment, associated with a store, and used for B2B Commerce. This object is available in API version 52.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
    },
    "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 promotion segment."
    },
    "PromotionSegmentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the promotion segment you want to associate with your store. This is a relationship field.",
      "relationship_name": "PromotionSegment",
      "relationship_type": "Lookup",
      "refers_to": "PromotionSegment"
    },
    "SalesStoreId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the store you want to include in your promotion segment. This is a relationship field.",
      "relationship_name": "SalesStore",
      "relationship_type": "Lookup",
      "refers_to": "WebStore"
    }
  },
  "special_access_rules": "The PromotionSegmentSalesStore object is available only if the B2B Commerce license is enabled.",
  "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- **PromotionSegmentSalesStoreFeed**: Feed tracking is available for the object.\n- **PromotionSegmentSalesStoreHistory**: 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 Segment Sales Store 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 Segment Sales Store Name",
      "type": "string",
      "length": "255"
    },
    "PromotionSegmentId": {
      "field_label": "Promotion Segment ID",
      "type": "reference",
      "length": "18"
    },
    "SalesStoreId": {
      "field_label": "Sales Store ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}