commerce/orders/returnableitems

Use this subresource to view which order items are eligible for return.

JSON Example

OrderReturnableItem Properties

Property Description
excludeProductExtras

type: bool

Specifies whether to exclude product extras when you return a product or bundle. For example, assume the following order items:

Product Bundle

  • Product A (bundle item)
  • Product B (bundle item)
  • Product C (bundle item)
  • Product D (extra on bundle)

Product E

  • Product F (extra on product)

If this property is false, Products D or F are included when the bundle or Product E are added to a return. If this property is true, Products D or F are not included unless added individually.

Tip:  This property is nullable, so the possible values are true, false, or null (empty, defaults to false behavior).

fulfillmentStatus

type: string

The fulfillment status of the item, which is one of the following values:

  • Fulfilled
  • Not Fulfilled

orderItemId

type: string

Unique identifier of the order item associated with a validation message, order, or return.

orderItemOptionAttributeFQN

type: string

The fully-qualified name of an attribute option on the item if it has an extra. For bundle items, this property is null.

orderLineId

type: int

The unique identifier of the line number associated with the item.

parentProductCode

type: string

The product code of the parent item, if applicable. For example, a product bundle is the parent of the items in the bundle, and a product is the parent of a product extra.

parentProductName

type: string

The name of the parent item, if applicable. For example, a product bundle is the parent of the items in the bundle, and a product is the parent of a product extra.

productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

quantityDirectlyReturned

type: int

The quantity of the item that a shopper or CSR has directly requested for return. For example, if someone requests a return on a product bundle, the bundle is directly returned, but the bundle items are indirectly returned. Conversely, if someone requests a return on a bundle item, the bundle item is directly returned, while the bundle is indirectly returned (in this case, the bundle is only partially returned, unless the other bundle items are also requested for return).

quantityFulfilled

type: int

The quantity that has been fulfilled for the given line item. An item must be fulfilled before it is returnable. If an order contains Product X with a quantity of 3, and the quantity fulfilled is 2, then two Product X items are returnable (assuming all other return conditions are met).

quantityIndirectlyReturned

type: int

The quantity of the item that is required for the successful return of another item. For example, if someone requests a return on a product bundle, the bundle is directly returned, but the bundle items are indirectly returned. Conversely, if someone requests a return on a bundle item, the bundle item is directly returned, while the bundle is indirectly returned (in this case, the bundle is only partially returned, unless the other bundle items are also requested for return).

quantityOrdered

type: int

The total quantity of an item on the order.

quantityReturnable

type: int

The quantity of a given item that is eligible for return. This number may be smaller than the quantity ordered, and changes depending on the actions taken on the return. For example, if an order contains five of Product X, but only three of those items are fulfilled, then only three items show as returnable (assuming all other return conditions are met).

unitQuantity

type: int

The number of discrete units that make up an individual item. For example, 1 (ordered quantity) bag of screws may contain a unity quantity of 50 screws.

Operations

Operation Name Request URI Description
GetOrderReturnableItems GET %7borderId%7d%2freturnableitems%3fresponseFields%3d%7bresponseFields%7d

Retrieves information about which items are eligible for return on an order.

Each item displays the following information:

  • One entry that represents the entire order item, whether this is a single product, a bundle, or a product or bundle with extras. (ParentProductCode == null, ExcludeProductExtras == false)
  • (If the item contains product extras)
    • One entry that represents the parent product without product extras (ParentProductCode == null, ExcludeProductExtras == true)
    • One entry for each extra (ParentProductCode != null, OrderItemOptionAttributeFQN != null)
  • (If the parent item is a bundle)
    • One entry for each item within the bundle (ParentProductCode != null, OrderItemOptionAttributeFQN == null)
Note:  The returnable items quantity may not match the quantity of items ordered, and changes depending on the actions taken on the return. For example, if an order contains five of Product X, but only three of those items are fulfilled, then only three items show as returnable (assuming all other return conditions are met).