OrderItemRelationship

Describes a relationship between order products.

Introduced in API version 57.0.

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

  • This object is available when Subscription Management or Revenue Cloud is enabled.

  • Type: reference

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

  • Description:

    The unique identifier of the associated order product.

    This field is a relationship field. In a bundle relationship, this order product is the bundle component.

  • Relationship name: AssociatedOrderItem

  • Relationship type: relationship

  • Refers to: OrderItem

  • Type: picklist

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

  • Introduced: API version 62.0

  • Description:

    A static enum that describes the associated order item inventory in the OrderItemSummaryRelationship.

    Possible values are:

    • IncludedInMainInventory—The child product’s inventory is included in the main inventory.
    • NotIncludedInMainInventory—The child product’s inventory isn’t included in the main inventory.

  • Possible values:

    • IncludedInMainInventory — IncludedInMainInventory
    • NotIncludedInMainInventory — NotIncludedInMainInventory
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Indicates how the associated order product is priced relative to the main order product. The value is informative; the system doesn’t check whether the associated order product is included in the bundle price.
  • Possible values:
    • IncludedInBundlePrice — IncludedInBundlePrice — The associated order product’s cost is $0 because it’s included in the bundle’s price.
    • NotIncludedInBundlePrice — NotIncludedInBundlePrice — The associated order product has a cost because it’s not included in the bundle’s price.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Describes the position of the associated order product in the relationship.
  • Possible values:
    • BundleComponent — BundleComponent — The associated order product is part of a bundle.
    • SetComponent — SetComponent — The associated order product is part of a set.

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description:

    How the quantity of the associated order product scales, relative to the main order product. The value is informative; the system doesn’t check whether the scaled quantities are correct.

    The default value is Proportional.

  • Possible values:

    • Constant — Constant — The associated order’s product quantity remains the same in relation to the main order product’s quantity. For example, the main order product has a quantity of one and the associated order product has a quantity of one.
    • Proportional — Proportional (default) — The associated order’s product quantity increases or decreases based on the main order product’s quantity. For example, the main order product has a quantity of one and the associated order product has a quantity of two. In other words, there are two associated order products for every one main order product.

  • Default value: Proportional

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Introduced: API version 66.0

  • Description:

    Indicates whether child products are included in the root bundle price. If set to true, the price of each child product is zero.

    The default value is false.

  • Default value: false

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The main order product’s unique identifier.

    This field is a relationship field. In a bundle relationship, this order product is the bundle parent.

  • Relationship name: MainOrderItem

  • Relationship type: masterdetail

  • Refers to: OrderItem

  • Type: picklist

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Description:

    Indicates the role of the main order product in the relationship.

    Subscription Management doesn’t support the Set value.

  • Possible values:

    • Bundle — Bundle — The main order product is the bundle parent.
    • Set — Set — The main order product is the set parent.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the order product relationship.

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    The unique identifier of the related order.

    This field is a relationship field.

  • Relationship name: Order

  • Relationship type: relationship

  • Refers to: Order

  • Type: reference

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

  • Introduced: API version 60.0

  • Relationship name: ProductRelatedComponent

  • Relationship type: relationship

  • Refers to: ProductRelatedComponent

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The unique identifier of the record that describes the relationship between the main and associated order products.

    This field is a relationship field.

  • Relationship name: ProductRelationshipType

  • Relationship type: relationship

  • Refers to: ProductRelationshipType

  • Type: reference

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

  • Introduced: API version 66.0

  • Description:

    The root order item for the order item relationship. In a bundle relationship, the root order item is the root bundle.

    This field is a relationship field.

  • Relationship name: RootOrderItem

  • Relationship type: relationship

  • Refers to: OrderItem

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.