ConnectApi.ReturnOrderInputRepresentation

Data for creating a ReturnOrder and ReturnOrderLineItems.
Property Type Description Required or Optional Available Version
orderSummaryId String ID of the OrderSummary containing the items to be returned. The OrderSummary’s OrderLifeCycleType must be Managed. Required 50.0
refundInstructionsHint List<ConnectApi.​RefundInstructionsHint​InputRepresentation> The payment credit sequence, credit types, and refund sequence that provide information for optimal refund processing. Optional 65.0
returnOrder​LifeCycleType String The LifeCycleType of the ReturnOrder. Possible values are:
  • Managed—Process the ReturnOrder using the APIs and actions. It can generate change orders and affects financial fields and rollup calculations.
  • Unmanaged—The ReturnOrder is for tracking purposes only. It isn’t involved in any financial calculations and doesn’t generate any change orders. The system doesn’t prevent the creation of duplicate ReturnOrderLineItems in an unmanaged ReturnOrder for the same OrderItem.
Required 51.0
returnOrderLineItems List<ConnectApi.​ReturnOrderLineItem​InputRepresentation> List of data for creating ReturnOrderLineItems. At least one element is required 50.0
status String Status to assign the ReturnOrder. This value must match an entry in the ReturnOrder object’s Status picklist. Required 51.0