OrderAdjustmentGroup

Group containing a set of adjustments applied to an order.

Introduced in API version 48.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

  • To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Description:

    References the specific coupon applied.

    This is a polymorphic relationship field.

  • Relationship name: AdjustmentBasisReference

  • Relationship type: polymorphic

  • Refers to: Coupon, FtestConcrete

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 52.0

  • Description:

    References the specific promotions applied.

    This field is a polymorphic relationship field.

  • Relationship name: AdjustmentCause

  • Relationship type: polymorphic

  • Refers to: FtestMain, PriceAdjustmentTier, Promotion

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 57.0
  • Description: Indicates the origin of the adjustment.
  • Possible values:
    • Discretionary — Discretionary — The adjustment originates from a decision made by an individual, for example, a manager’s discount granted to a client.
    • Promotion — Promotion — The adjustment originates from a promotion, for example, a holiday sale discount.
    • Rule — Rule — Reserved for future use.
    • System — System — The adjustment originates from the system, for example, a volume discount after the amount of items reaches a specific number.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 67.0

  • Relationship name: AdjustmentTier

  • Relationship type: relationship

  • Refers to: PromotionTier

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 57.0
  • Description: Indicates the type of mathematical adjustment to be applied to the order.
  • Possible values:
    • AdjustmentAmount — AdjustmentAmount — The adjustment is a numerical amount, for example, a cash discount of 20.
    • AdjustmentPercentage — AdjustmentPercentage — The adjustment is a percentage amount, for example, a 10% discount.
    • OverrideAmount — OverrideAmount — The adjustment is a manual price override.

  • Type: double

  • Properties: Create, Filter, Nillable, Sort, Update

  • Introduced: API version 57.0

  • Description:

    The specified AdjustmentType’s amount to be applied to the order.

    For example, when the AdjustmentType value is AdjustmentAmount, the AdjustmentValue is expected to equal the value of the TotalAmount field.

    When the AdjustmentType value is AdjustmentPercentage, the AdjustmentValue represents the percentage number, and the TotalAmount field’s value will show the calculated adjustment amount.

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: User-entered information about the order adjustment group.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The sum of all total amounts of all adjustments in this group, including tax.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The user-defined name of the order adjustment group.

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The unique identifier of the order related to the adjustments in this order adjustment group.

    This field is a relationship field.

  • Relationship name: Order

  • Relationship type: masterdetail

  • Refers to: Order

  • Type: int

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 57.0

  • Description:

    A numeric value that represents the order of precedence of the order adjustment group.

    It can also represent the order of precedence when applying the AdjustmentType values. For example, an order can have two adjustments: a $100 discount and a 10% discount. This field will tell the pricing engine which adjustment needs to be applied first.

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    The unique identifier of the original order’s adjustment group. This field is a useful reference in change order scenarios.

    This field is a relationship field.

  • Relationship name: RelatedAdjustmentGroup

  • Relationship type: relationship

  • Refers to: OrderAdjustmentGroup

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The total of all order adjustments in this order adjustment group, excluding tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The total tax for all order adjustments in this order adjustment group.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Indicates how the adjustment was applied to the order.
  • Possible values:
    • Header — Header — The adjustment was applied to the order’s balance, and then distributed among the order products in the adjustment group.
    • SplitLine — SplitLine — The adjustment was applied to order product balances for the order products in the adjustment group.

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.