ReturnOrderLineItem

Represents a specific product that is returned or repaired as part of a return order in Field service, or a specific order item that is returned as part of a return order in Order Management.

Return orders are available in Lightning Experience, Salesforce Classic, the Salesforce mobile app, the Field Service mobile app for Android and iOS, and communities built using Salesforce Tabs + Visualforce.

Introduced in API version 42.0.

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

  • Field Service or Order Management must be enabled.

  • Type: reference

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

  • Description:

    The asset associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId.

    This is a relationship field.

  • Relationship name: Asset

  • Relationship type: relationship

  • Refers to: Asset

  • Type: reference

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

  • Introduced: API version 50.0

  • Description:

    ID of the change order item associated with the return order line item.

    This is a relationship field.

  • Relationship name: ChangeOrderItem

  • Relationship type: relationship

  • Refers to: OrderItem

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Notes or context about the return order line item.

  • Type: reference

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

  • Description:

    The location where the items are being returned to. For example, if the return order tracks the return of products from a technician’s van to a warehouse, the warehouse is the destination location.

    This is a relationship field.

  • Relationship name: DestinationLocation

  • Relationship type: relationship

  • Refers to: Location

  • Type: reference

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

  • Introduced: API version 67.0

  • Relationship name: GoodsReceivedNoteItem

  • Relationship type: relationship

  • Refers to: GoodsReceivedNoteItem

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Unit price, including tax, of the product represented by the associated order item summary.

  • Type: reference

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

  • Description:

    The order product associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId.

    This is a relationship field.

  • Relationship name: OrderItem

  • Relationship type: relationship

  • Refers to: OrderItem

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 50.0
  • Description: ID of the order item summary associated with the return order line item.
  • Relationship name: OrderItemSummary
  • Relationship type: relationship
  • Refers to: OrderItemSummary
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Indicates the preferred fate of the items following their return. Available values are:
  • Possible values:
    • Repair — Repair — Repair the items and return them to the owner
    • Discard — Discard — Discard the items
    • Salvage — Salvage — Salvage the items’ working parts
    • Restock — Restock — Return the items to your inventory

  • Type: reference

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

  • Description:

    The product associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId.

    This is a relationship field.

  • Relationship name: Product2

  • Relationship type: relationship

  • Refers to: Product2

  • Type: reference

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

  • Description:

    The product item representing the location of the product at the start of the return. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId.

    This is a relationship field.

  • Relationship name: ProductItem

  • Relationship type: relationship

  • Refers to: ProductItem

  • Type: reference

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

  • Description:

    The product request line item associated with the return order line item. One or more of the following fields must be filled out: AssetId, OrderItemId, Product2Id, ProductItemId, and ProductRequestLineItemId.

    This is a relationship field.

  • Relationship name: ProductRequestLineItem

  • Relationship type: relationship

  • Refers to: ProductRequestLineItem

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 51.0
  • Description: The product service campaign associated with the return order line item.
  • Relationship name: ProductServiceCampaign
  • Relationship type: relationship
  • Refers to: ProductServiceCampaign
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The product service campaign item associated with the return order line item.
  • Relationship name: ProductServiceCampaignItem
  • Relationship type: relationship
  • Refers to: ProductServiceCampaignItem
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: The quantity of items expected to be returned.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: The actual quantity of items received for return.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: The quantity of items rejected for return.
  • Type: double
  • Properties: Create, Filter, Sort, Update
  • Description: The quantity of items being returned. If multiple types of products are being returned, track each product in a different return order line item.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Units of the returned items; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 59.0
  • Description: Details about the reason for return change

  • Type: picklist

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

  • Introduced: API version 50.0

  • Description:

    Reason for rejecting returned items on this return order line item.

    The default value is Missing Item or Part.

  • Possible values:

    • Damaged Item — Damaged Item
    • Expired Warranty — Expired Warranty
    • Missing Item or Part — Missing Item or Part (default)
    • Wrong Item — Wrong Item

  • Default value: Missing Item or Part

  • Type: picklist

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

  • Description:

    The reason the items are being returned. Available values are:

    The default value is Damaged.

  • Possible values:

    • Damaged — Damaged (default)
    • Defective — Defective
    • Duplicate Order — Duplicate Order
    • Wrong Item — Wrong Item
    • Wrong Quantity — Wrong Quantity
    • Not Satisfied — Not Satisfied
    • Outdated — Outdated
    • Other — Other

  • Default value: Damaged

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The method by which the customer or owner will be reimbursed for the items being returned. Available values are:
  • Possible values:
    • Replace — Replace — The items will be replaced
    • Refund — Refund — The items will be returned and the owner will be refunded
    • Credit — Credit — The items will be returned and the owner will receive credit for them
    • Return — Return — The items will be returned to the owner (for example, following their repair)

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The return order that the return order line item belongs to.

    This is a relationship field.

  • Relationship name: ReturnOrder

  • Relationship type: masterdetail

  • Refers to: ReturnOrder

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: (Read only) Auto-generated number that identifies the return order line item.

  • Type: reference

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

  • Description:

    The items’ location at the start of the return or repair. For example, if the return order tracks the return of products from a technician’s service vehicle to a warehouse, the service vehicle is the source location.

    This is a relationship field.

  • Relationship name: SourceLocation

  • Relationship type: relationship

  • Refers to: Location

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Total of all price adjustments applied to the return order line item.

    This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Total amount of the price adjustments applied to the return order line item, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount.

    This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Tax on the TotalAdjustmentAmount.

    This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Total, including adjustments and tax, of the return order line item.

    This is a calculated field.

  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Total, not including adjustments or tax, of the return order line item.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Total price of the return order line item, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount.

    This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Tax on the TotalLineAmount.

    This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Total, including adjustments but not tax, of the return order line item. Equal to UnitPrice times Quantity.

    This is a calculated field.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 50.0

  • Description:

    Tax on the TotalAmount.

    This is a calculated field.

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 50.0
  • Description: Type of the return order line item. Matches the type of the associated order item summary. Delivery Charge indicates that the return order line item represents a delivery charge. Fee indicates that it represents another type of fee, such as a return fee. Order Product indicates that it represents any other type of product, service, or charge. Each type corresponds to one type code, shown here in parentheses.
  • Possible values:
    • Delivery Charge (Charge) — Delivery Charge (Charge)
    • Fee (Charge) — Fee (Charge)
    • Order Product (Product) — Order Product (Product)
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 50.0
  • Description: Type code of the return order line item. Matches the type code of the associated order item summary. Processing depends on this value. Charge indicates that the return order line item represents a delivery charge. Product indicates that it represents an other type of product, service, or charge. Each type category corresponds to one or more types.
  • Possible values:
    • Charge — Charge
    • Product — Product
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Unit price of the return order line item.

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.