Get Return Item

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "orderItemId": "<string>",
  "orderLineId": 123,
  "orderItemOptionAttributeFQN": "<string>",
  "product": {
    "productCode": "<string>",
    "name": "<string>",
    "description": "<string>",
    "goodsType": "<string>",
    "isPackagedStandAlone": true,
    "stock": {
      "manageStock": true,
      "isOnBackOrder": true,
      "availableDate": "2023-11-07T05:31:56Z",
      "stockAvailable": 123,
      "aggregateInventory": 123,
      "futureInventories": [
        {
          "futureInventoryID": 123,
          "onhand": 123,
          "available": 123,
          "allocated": 123,
          "pending": 123,
          "deliveryDate": "2023-11-07T05:31:56Z",
          "createDate": "2023-11-07T05:31:56Z"
        }
      ],
      "availableFutureInventories": 123,
      "totalAvailableStock": 123,
      "isSubstitutable": true
    },
    "productReservationId": 123,
    "allocationId": 123,
    "allocationExpiration": "2023-11-07T05:31:56Z",
    "measurements": {
      "height": {
        "unit": "<string>",
        "value": 123
      },
      "width": {
        "unit": "<string>",
        "value": 123
      },
      "length": {
        "unit": "<string>",
        "value": 123
      },
      "weight": {
        "unit": "<string>",
        "value": 123
      }
    },
    "fulfillmentStatus": "<string>",
    "mfgPartNumber": "<string>",
    "upc": "<string>",
    "sku": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "imageAlternateText": "<string>",
    "imageUrl": "<string>",
    "variationProductCode": "<string>",
    "options": [
      {
        "name": "<string>",
        "value": "<unknown>",
        "shopperEnteredValue": "<unknown>",
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "stringValue": "<string>"
      }
    ],
    "properties": [
      {
        "attributeFQN": "<string>",
        "name": "<string>",
        "dataType": "<string>",
        "isMultiValue": true,
        "values": [
          {
            "stringValue": "<string>",
            "value": "<unknown>"
          }
        ]
      }
    ],
    "categories": [
      {
        "id": 123,
        "parent": {}
      }
    ],
    "price": {
      "price": 123,
      "salePrice": 123,
      "tenantOverridePrice": 123,
      "msrp": 123,
      "creditValue": 123,
      "priceListCode": "<string>",
      "priceListEntryMode": "<string>",
      "isOverRidePriceSalePrice": true
    },
    "discountsRestricted": true,
    "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
    "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
    "isRecurring": true,
    "isTaxable": true,
    "productType": "<string>",
    "productUsage": "<string>",
    "serialNumber": "<string>",
    "condition": "<string>",
    "bundledProducts": [
      {
        "productCode": "<string>",
        "name": "<string>",
        "description": "<string>",
        "goodsType": "<string>",
        "isPackagedStandAlone": true,
        "stock": {
          "manageStock": true,
          "isOnBackOrder": true,
          "availableDate": "2023-11-07T05:31:56Z",
          "stockAvailable": 123,
          "aggregateInventory": 123,
          "futureInventories": [
            {
              "futureInventoryID": 123,
              "onhand": 123,
              "available": 123,
              "allocated": 123,
              "pending": 123,
              "deliveryDate": "2023-11-07T05:31:56Z",
              "createDate": "2023-11-07T05:31:56Z"
            }
          ],
          "availableFutureInventories": 123,
          "totalAvailableStock": 123,
          "isSubstitutable": true
        },
        "productReservationId": 123,
        "allocationId": 123,
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          }
        },
        "fulfillmentStatus": "<string>",
        "quantity": 123,
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "creditValue": 123,
        "deltaPrice": 123,
        "imageUrl": "<string>"
      }
    ],
    "fulfillmentFields": [
      {
        "name": "<string>",
        "userEnteredValue": "<unknown>",
        "required": true
      }
    ]
  },
  "reasons": [
    {
      "reason": "<string>",
      "quantity": 123
    }
  ],
  "excludeProductExtras": true,
  "returnType": "<string>",
  "returnNotRequired": true,
  "quantityReceived": 123,
  "receiveStatus": "<string>",
  "quantityShipped": 123,
  "replaceStatus": "<string>",
  "quantityRestockable": 123,
  "quantityRestocked": 123,
  "refundAmount": 123,
  "returnProcessingFeeApplied": 123,
  "shippingAndHandlingRefunded": true,
  "quantityRefunded": 123,
  "refundStatus": "<string>",
  "quantityReplaced": 123,
  "notes": [
    {
      "id": "<string>",
      "text": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "productLossAmount": 123,
  "productLossTaxAmount": 123,
  "shippingLossAmount": 123,
  "shippingLossTaxAmount": 123,
  "bundledProducts": [
    {
      "productCode": "<string>",
      "quantity": 123
    }
  ],
  "totalWithoutWeightedShippingAndHandling": 123,
  "totalWithWeightedShippingAndHandling": 123,
  "shipmentItemId": 123,
  "shipmentNumber": 123,
  "data": {},
  "taxData": {},
  "inventoryTags": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "dispositionInfo": [
    {
      "quantity": 123,
      "locationCode": "<string>",
      "condition": "<string>",
      "status": "<string>"
    }
  ],
  "attributes": [
    {
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fullyQualifiedName": "<string>",
      "attributeDefinitionId": 123,
      "values": [
        "<unknown>"
      ]
    }
  ]
}

GET

commerce

returns

{returnId}

items

{returnItemId}

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "orderItemId": "<string>",
  "orderLineId": 123,
  "orderItemOptionAttributeFQN": "<string>",
  "product": {
    "productCode": "<string>",
    "name": "<string>",
    "description": "<string>",
    "goodsType": "<string>",
    "isPackagedStandAlone": true,
    "stock": {
      "manageStock": true,
      "isOnBackOrder": true,
      "availableDate": "2023-11-07T05:31:56Z",
      "stockAvailable": 123,
      "aggregateInventory": 123,
      "futureInventories": [
        {
          "futureInventoryID": 123,
          "onhand": 123,
          "available": 123,
          "allocated": 123,
          "pending": 123,
          "deliveryDate": "2023-11-07T05:31:56Z",
          "createDate": "2023-11-07T05:31:56Z"
        }
      ],
      "availableFutureInventories": 123,
      "totalAvailableStock": 123,
      "isSubstitutable": true
    },
    "productReservationId": 123,
    "allocationId": 123,
    "allocationExpiration": "2023-11-07T05:31:56Z",
    "measurements": {
      "height": {
        "unit": "<string>",
        "value": 123
      },
      "width": {
        "unit": "<string>",
        "value": 123
      },
      "length": {
        "unit": "<string>",
        "value": 123
      },
      "weight": {
        "unit": "<string>",
        "value": 123
      }
    },
    "fulfillmentStatus": "<string>",
    "mfgPartNumber": "<string>",
    "upc": "<string>",
    "sku": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "imageAlternateText": "<string>",
    "imageUrl": "<string>",
    "variationProductCode": "<string>",
    "options": [
      {
        "name": "<string>",
        "value": "<unknown>",
        "shopperEnteredValue": "<unknown>",
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "stringValue": "<string>"
      }
    ],
    "properties": [
      {
        "attributeFQN": "<string>",
        "name": "<string>",
        "dataType": "<string>",
        "isMultiValue": true,
        "values": [
          {
            "stringValue": "<string>",
            "value": "<unknown>"
          }
        ]
      }
    ],
    "categories": [
      {
        "id": 123,
        "parent": {}
      }
    ],
    "price": {
      "price": 123,
      "salePrice": 123,
      "tenantOverridePrice": 123,
      "msrp": 123,
      "creditValue": 123,
      "priceListCode": "<string>",
      "priceListEntryMode": "<string>",
      "isOverRidePriceSalePrice": true
    },
    "discountsRestricted": true,
    "discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
    "discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
    "isRecurring": true,
    "isTaxable": true,
    "productType": "<string>",
    "productUsage": "<string>",
    "serialNumber": "<string>",
    "condition": "<string>",
    "bundledProducts": [
      {
        "productCode": "<string>",
        "name": "<string>",
        "description": "<string>",
        "goodsType": "<string>",
        "isPackagedStandAlone": true,
        "stock": {
          "manageStock": true,
          "isOnBackOrder": true,
          "availableDate": "2023-11-07T05:31:56Z",
          "stockAvailable": 123,
          "aggregateInventory": 123,
          "futureInventories": [
            {
              "futureInventoryID": 123,
              "onhand": 123,
              "available": 123,
              "allocated": 123,
              "pending": 123,
              "deliveryDate": "2023-11-07T05:31:56Z",
              "createDate": "2023-11-07T05:31:56Z"
            }
          ],
          "availableFutureInventories": 123,
          "totalAvailableStock": 123,
          "isSubstitutable": true
        },
        "productReservationId": 123,
        "allocationId": 123,
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          }
        },
        "fulfillmentStatus": "<string>",
        "quantity": 123,
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "creditValue": 123,
        "deltaPrice": 123,
        "imageUrl": "<string>"
      }
    ],
    "fulfillmentFields": [
      {
        "name": "<string>",
        "userEnteredValue": "<unknown>",
        "required": true
      }
    ]
  },
  "reasons": [
    {
      "reason": "<string>",
      "quantity": 123
    }
  ],
  "excludeProductExtras": true,
  "returnType": "<string>",
  "returnNotRequired": true,
  "quantityReceived": 123,
  "receiveStatus": "<string>",
  "quantityShipped": 123,
  "replaceStatus": "<string>",
  "quantityRestockable": 123,
  "quantityRestocked": 123,
  "refundAmount": 123,
  "returnProcessingFeeApplied": 123,
  "shippingAndHandlingRefunded": true,
  "quantityRefunded": 123,
  "refundStatus": "<string>",
  "quantityReplaced": 123,
  "notes": [
    {
      "id": "<string>",
      "text": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "productLossAmount": 123,
  "productLossTaxAmount": 123,
  "shippingLossAmount": 123,
  "shippingLossTaxAmount": 123,
  "bundledProducts": [
    {
      "productCode": "<string>",
      "quantity": 123
    }
  ],
  "totalWithoutWeightedShippingAndHandling": 123,
  "totalWithWeightedShippingAndHandling": 123,
  "shipmentItemId": 123,
  "shipmentNumber": 123,
  "data": {},
  "taxData": {},
  "inventoryTags": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "dispositionInfo": [
    {
      "quantity": 123,
      "locationCode": "<string>",
      "condition": "<string>",
      "status": "<string>"
    }
  ],
  "attributes": [
    {
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fullyQualifiedName": "<string>",
      "attributeDefinitionId": 123,
      "values": [
        "<unknown>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

returnId

string

required

Unique identifier of the return whose item you want to get.

returnItemId

string

required

Unique identifier of the return item whose details you want to get.

Query Parameters

responseFields

string

limits which fields are returned in the response body

Response

Success

string | null

The identifier of the return

orderItemId

string | null

The OrderItem that this ReturnItem is associated with. Either the Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.Product or the OrderItemId must be present.

orderLineId

integer<int32> | null

The OrderLineId that this ReturnItem is associated with. If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.OrderItemId is present, the OrderLineId should be present also.

orderItemOptionAttributeFQN

string | null

If this item refers to a product extra, provide the item's corresponding OptionAttributeFQN.

product

object

The product as it appears on the order item.

Show child attributes

reasons

object[] | null

For a given return reason (Damaged, Defective, MissingParts, DifferentExpectations, Late, NoLongerWanted, Other), how many of the above OrderItem are to be replaced. This value is provided by the Shopper when they request a Return.

Show child attributes

excludeProductExtras

boolean | null

If this return item refers to a product/bundle that has product extras, this specifies whether those child items should be included or excluded. For backward compatibility, a null value will be treated as false, i.e. include the extras.

returnType

string | null

Specifies whether the requested resolution for this item is Refund or Replace.

returnNotRequired

boolean

Specifies whether this item should be returned to the merchant, e.g. if the item is irreparably damaged and it's not worth shipping back. Even if this is set to true, Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.QuantityShipped should still be set to the quantity of items involved in the return.

quantityReceived

integer<int32>

The amount of this item actually received from the shopper. It may differ from the sum of the ReturnReasons. This is populated by the system when the Receive action is performed.

receiveStatus

string | null

Describes the receive status of this item. If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ReturnNotRequired is {true}, then this should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReceiveStatusConst.NOT_REQUESTED. Otherwise the value should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReceiveStatusConst.RECEIVED or Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReceiveStatusConst.WAITING depending on Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.QuantityReceived.

quantityShipped

integer<int32>

The quantity of this item fulfilled on the parent order.

replaceStatus

string | null

Describes the replace status of this item. If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ReturnType is Mozu.CommerceRuntime.Contracts.Returns.Return.ReturnTypeConst.REFUND, then this should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReplaceStatusConst.NOT_REQUESTED. Otherwise the value should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReplaceStatusConst.REPLACED or Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemReplaceStatusConst.NOT_REPLACED depending on Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.QuantityReplaced.

quantityRestockable

integer<int32>

Of the quantity returned, how many of this item can be added back into the inventory? This item is set by the merchant via an UpdateReturn call. It is used during the Restock action to set some quantity of this item back into the inventory management system.

quantityRestocked

integer<int32>

Field to specify How many items added to inventory

refundAmount

number<double> | null

If a refund is issued for the return, how much of the refund amount is for this particular item.

returnProcessingFeeApplied

number<double> | null

The processing fee on the item that gets persisted into the database

shippingAndHandlingRefunded

boolean | null

Determines if shipping and handling is returned on the item

quantityRefunded

integer<int32>

The quantity of the item being refunded is specified in this field

refundStatus

string | null

Describes the refund status of this item. If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ReturnType is Mozu.CommerceRuntime.Contracts.Returns.Return.ReturnTypeConst.REPLACE, then this should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemRefundStatusConst.NOT_REQUESTED. Otherwise the value should be Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemRefundStatusConst.REFUNDED or Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.ItemRefundStatusConst.NOT_REFUNDED depending on Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.RefundAmount.

quantityReplaced

integer<int32> | null

Specifies the quantity of this item that has been marked as replaced, i.e. it has been used to generate a replacement order for the return. Note that the quantity replaced may not line up with the quantity of the item actually sent back to the shopper, such as in the case of an exchange, e.g. swapping a medium shirt for a large shirt.

notes

object[] | null

Any merchant-supplied notes for this ReturnItem.

Show child attributes

productLossAmount

number<double> | null

The loss incurred of the returned products, used for accounting purposes.

productLossTaxAmount

number<double> | null

The tax on the returned products, used for accounting purposes.

shippingLossAmount

number<double> | null

The loss incurred of the returned product shipping, used for accounting purposes.

shippingLossTaxAmount

number<double> | null

The tax on the returned product shipping, used for accounting purposes.

bundledProducts

object[] | null

deprecated

Deprecated. Not used.

Show child attributes

totalWithoutWeightedShippingAndHandling

number<double> | null

Taxable Subtotal including Weighted Order amounts

totalWithWeightedShippingAndHandling

number<double> | null

Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs

shipmentItemId

integer<int32> | null

The identifier of the item

shipmentNumber

integer<int32> | null

data

object

Custom data for a given vendor set within the commerce process.

taxData

object

Additional tax-related data for this return item.

inventoryTags

object[] | null

Show child attributes

dispositionInfo

object[] | null

Show child attributes

attributes

object[] | null

Collection of attributes defined for this return item.

Show child attributes

Create Return Item

Delete Order Item

⌘I

Developers

API reference

Authorizations

Path Parameters

Query Parameters

Response