{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules"
  ],
  "title": "PriceAdjustmentGroupShape - Data API",
  "description": "Defines the business logic for a top-level price adjustment, for example, a discount applied to an entire order. This object is available in API version 57.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AdjustmentSource": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the source of the adjustment. This field is available with B2B Commerce. Possible values are: Discretionary—The adjustment is entered manually, for example, by a sales rep. Promotion—The adjustment is part of a promotion. Rule—Reserved for future use. System—The adjustment is configured by the system data, for example, as part of a pricing rule or discount schedule."
    },
    "AdjustmentType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates whether the adjustment is a percentage, an amount, or an override. Possible values are: AdjustmentAmount—Reserved for future use. The adjustment value is a numerical amount. AdjustmentPercentage— The adjustment value is a percentage. OverrideAmount— The override value is a numerical amount."
    },
    "AdjustmentValue": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "The value of the adjustment. To indicate a discount, use a negative number."
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable",
      "description": "User-entered description of the price adjustment group. Available in API versions 57.0."
    },
    "PriceAdjustmentCauseId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the record that is the source of the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the price adjustment tier record. This field is a polymorphic relationship field.",
      "relationship_name": "PriceAdjustmentCause",
      "relationship_type": "Lookup",
      "refers_to": "PriceAdjustmentTier"
    },
    "PriceAdjustmentGroupShapeName": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort",
      "description": "Name of the price adjustment group shape."
    },
    "Priority": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "A positive integer indicating the order in which this price adjustment group is applied, relative to other price adjustment groups. A Priority of 1 indicates this price adjustment group is applied first.Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied before amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. Note: The value of Priority must be unique among price adjustment groups in the same sales transaction."
    },
    "SalesTransactionShapeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the sales transaction that the price adjustment group belongs to. This field is a relationship field.",
      "relationship_name": "SalesTransactionShape",
      "relationship_type": "Lookup",
      "refers_to": "SalesTransactionShape"
    },
    "TotalAmount": {
      "type": "currency",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "The total amount of adjustments of all related price adjustment items, inclusive of quantity, prorated for the duration of the subscription. This field is a calculated field equal to the sum of the TotalAmount fields in the related price adjustment items."
    }
  },
  "special_access_rules": "This object is available with Subscription Management, B2B Commerce, or B2C Commerce."
}