The generic ReturnsDeliveryStatus business object is one of the generic business objects that work with the Order Status collaboration template. It is used to capture the status of a returns order. Creation of the generic ReturnsDeliveryStatus business object is triggered when the status of a returns order is changed by a delivery activity, such as receipt of the returned items.
The ReturnsDeliveryStatus business object is an image of the underlying returns order. For example, if the order contains three line items, the business object contains the order header and the three line items from the order. If the triggering event affects only one line item of the returns order, the ReturnsDeliveryStatus business object still captures the current status of the header and each item.
The ReturnsDeliveryStatus business object is hierarchical. One of its attributes references the ReturnsDeliveryStatusLine child business object, which contains delivery status information about a line item in the associated returns order.
Each instance of an ReturnsDeliveryStatus business object matches the structure of its associated returns order. If the returns order has two line items, the ReturnsDeliveryStatus business object has two ReturnsDeliveryStatusLine business objects. These business objects contain information from their associated returns order header and line items as well as the delivery status and delivery information about the particular delivery whose status changed.
Whenever the delivery of a returned line item is received in the source application, the application's adapter creates an ReturnsDeliveryStatus business object. The business object references separate child business objects for each line item in the returns order, regardless of whether the delivery status of individual line items has changed.
For example, in a returns order with two line items, if the delivery status of only one line item changes, the ReturnsDeliveryStatus business object still has two ReturnsDeliveryStatusLine business objects. Only one of the child business objects contains the change in status. The other child business object contains no information specific to the current delivery.
The ReturnsDeliveryStatus business object and its child business object use five attributes to report the status of a line item's delivery. Table 1 explains the two status attributes used by the ReturnsDeliveryStatus business object.
Table 1: Status attributes in the ReturnsDeliveryStatus business object
Attribute | Value reported |
---|---|
ReturnDeliveryScheduledStatus | Indicates whether the deliveries for the entire returns order have been scheduled; that is, whether they have been created. For example, if there are two line items and the return of only one has been scheduled, this might contain a value of "Partially Scheduled". |
ReturnShipmentStatus | Overall return status of the returns order across all line items. For example, if there are two line items and only one has been received, this might contain a value of "Partially Returned". |
Table 2 explains the three status attributes used by the ReturnsDeliveryStatusLine business object.
Table 2: Status attributes in the ReturnsDeliveryStatusLine business object
Attribute | Value reported |
---|---|
ReturnLineDeliveryScheduledStatus | Overall schedule status of the line item it represents, summarizing the status of all scheduled returns for the line item. For example, if there are two return deliveries for the line item and only one has been scheduled, this might contain a value of "Partially Scheduled". |
OrderLineReturnStatus | Overall return status of the line item it represents, summarizing the status of all returns for the line item. For example, if there are two return deliveries for the line item and only one has been returned, this might contain a value of "Partially Returned". |
DeliveryReturnStatus | Return delivery status of the receipt that triggered creation of the business object. This attribute only has a value if the triggering return is for the line item represented by this child business object. For example, if the returns order has two line items and one of them has just been received, the ReturnsDeliveryStatusLine representing that line item might have a value of "Fully Returned" in this attribute; the child business object representing the other line item has no value in this attribute. |
For information on the business object's capability to handle complex delivery situations, such as a single returns order with multiple deliveries, see the generic OrderDeliveryStatus business object.
The generic ReturnsDeliveryStatus business object supports the following verbs:
To examine the attributes of the generic ReturnsDeliveryStatus business object, use System Manager or Process Designer Express.