Skip to main content
POST
/
commerce
/
returns
/
{returnId}
/
items
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "customerAccountId": 123,
  "visitId": "<string>",
  "webSessionId": "<string>",
  "customerInteractionType": "<string>",
  "availableActions": [
    "<string>"
  ],
  "returnNumber": 123,
  "contact": {
    "id": 123,
    "email": "<string>",
    "firstName": "<string>",
    "middleNameOrInitial": "<string>",
    "lastNameOrSurname": "<string>",
    "companyOrOrganization": "<string>",
    "phoneNumbers": {
      "home": "<string>",
      "mobile": "<string>",
      "work": "<string>"
    },
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "address4": "<string>",
      "cityOrTown": "<string>",
      "stateOrProvince": "<string>",
      "postalOrZipCode": "<string>",
      "countryCode": "<string>",
      "addressType": "<string>",
      "isValidated": true
    }
  },
  "locationCode": "<string>",
  "originalOrderId": "<string>",
  "originalOrderNumber": 123,
  "returnOrderId": "<string>",
  "currencyCode": "<string>",
  "status": "<string>",
  "pickupDate": "2023-11-07T05:31:56Z",
  "receiveStatus": "<string>",
  "refundStatus": "<string>",
  "replaceStatus": "<string>",
  "items": [
    {
      "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>"
          ]
        }
      ]
    }
  ],
  "notes": [
    {
      "id": "<string>",
      "text": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "rmaDeadline": "2023-11-07T05:31:56Z",
  "returnType": "<string>",
  "refundAmount": 123,
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "payments": [
    {
      "id": "<string>",
      "groupId": {
        "targetType": "<string>",
        "targetId": "<string>",
        "targetNumber": 123
      },
      "paymentServiceTransactionId": "<string>",
      "availableActions": [
        "<string>"
      ],
      "orderId": "<string>",
      "paymentType": "<string>",
      "paymentWorkflow": "<string>",
      "externalTransactionId": "<string>",
      "billingInfo": {
        "paymentType": "<string>",
        "paymentWorkflow": "<string>",
        "billingContact": {
          "id": 123,
          "email": "<string>",
          "firstName": "<string>",
          "middleNameOrInitial": "<string>",
          "lastNameOrSurname": "<string>",
          "companyOrOrganization": "<string>",
          "phoneNumbers": {
            "home": "<string>",
            "mobile": "<string>",
            "work": "<string>"
          },
          "address": {
            "address1": "<string>",
            "address2": "<string>",
            "address3": "<string>",
            "address4": "<string>",
            "cityOrTown": "<string>",
            "stateOrProvince": "<string>",
            "postalOrZipCode": "<string>",
            "countryCode": "<string>",
            "addressType": "<string>",
            "isValidated": true
          }
        },
        "isSameBillingShippingAddress": true,
        "card": {
          "paymentOrCardType": "<string>",
          "cardNumberPartOrMask": "<string>",
          "expireMonth": 123,
          "expireYear": 123,
          "bin": "<string>",
          "paymentServiceCardId": "<string>",
          "isUsedRecurring": true,
          "nameOnCard": "<string>",
          "isCardInfoSaved": true,
          "isTokenized": true,
          "ccLastFour": "<string>"
        },
        "token": {
          "paymentServiceTokenId": "<string>",
          "type": "<string>"
        },
        "purchaseOrder": {
          "purchaseOrderNumber": "<string>",
          "paymentTerm": {
            "code": "<string>",
            "description": "<string>"
          },
          "customFields": [
            {
              "code": "<string>",
              "label": "<string>",
              "value": "<string>"
            }
          ]
        },
        "check": {
          "checkNumber": "<string>"
        },
        "auditInfo": {
          "updateDate": "2023-11-07T05:31:56Z",
          "createDate": "2023-11-07T05:31:56Z",
          "updateBy": "<string>",
          "createBy": "<string>"
        },
        "storeCreditCode": "<string>",
        "storeCreditType": "<string>",
        "customCreditType": "<string>",
        "externalTransactionId": "<string>",
        "isRecurring": true,
        "recurringTransactionId": "<string>",
        "data": {}
      },
      "data": {},
      "status": "<string>",
      "subPayments": [
        {
          "status": "<string>",
          "amountCollected": 123,
          "amountCredited": 123,
          "amountRequested": 123,
          "amountRefunded": 123,
          "target": {
            "targetType": "<string>",
            "targetId": "<string>",
            "targetNumber": 123
          }
        }
      ],
      "interactions": [
        {
          "id": "<string>",
          "gatewayInteractionId": 123,
          "paymentId": "<string>",
          "orderId": "<string>",
          "target": {
            "targetType": "<string>",
            "targetId": "<string>",
            "targetNumber": 123
          },
          "currencyCode": "<string>",
          "interactionType": "<string>",
          "checkNumber": "<string>",
          "status": "<string>",
          "paymentEntryStatus": "<string>",
          "isRecurring": true,
          "isManual": true,
          "isPending": true,
          "gatewayTransactionId": "<string>",
          "gatewayAuthCode": "<string>",
          "gatewayAVSCodes": "<string>",
          "gatewayCVV2Codes": "<string>",
          "gatewayResponseCode": "<string>",
          "gatewayResponseText": "<string>",
          "gatewayResponseData": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "paymentTransactionInteractionIdReference": 123,
          "amount": 123,
          "note": "<string>",
          "interactionDate": "2023-11-07T05:31:56Z",
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "returnId": "<string>",
          "refundId": "<string>",
          "capturableShipmentsSummary": [
            {
              "shipmentNumber": 123,
              "shipmentTotal": 123,
              "amountApplied": 123
            }
          ]
        }
      ],
      "isRecurring": true,
      "amountCollected": 123,
      "amountCredited": 123,
      "amountRequested": 123,
      "changeMessages": [
        {
          "id": "<string>",
          "correlationId": "<string>",
          "userId": "<string>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userScopeType": "<string>",
          "appId": "<string>",
          "appKey": "<string>",
          "appName": "<string>",
          "subjectType": "<string>",
          "success": true,
          "identifier": "<string>",
          "subject": "<string>",
          "verb": "<string>",
          "message": "<string>",
          "metadata": "<unknown>",
          "oldValue": "<string>",
          "newValue": "<string>",
          "amount": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "attributes": {}
        }
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "gatewayGiftCard": {
        "id": "<string>",
        "cardNumber": "<string>",
        "cardPin": "<string>",
        "amount": 123,
        "currencyCode": "<string>"
      },
      "installmentPlanCode": "<string>"
    }
  ],
  "packages": [
    {
      "id": "<string>",
      "code": "<string>",
      "status": "<string>",
      "items": [
        {
          "productCode": "<string>",
          "quantity": 123,
          "fulfillmentItemType": "<string>",
          "lineId": 123,
          "optionAttributeFQN": "<string>"
        }
      ],
      "fulfillmentDate": "2023-11-07T05:31:56Z",
      "fulfillmentLocationCode": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "availableActions": [
        "<string>"
      ],
      "changeMessages": [
        {
          "id": "<string>",
          "correlationId": "<string>",
          "userId": "<string>",
          "userFirstName": "<string>",
          "userLastName": "<string>",
          "userScopeType": "<string>",
          "appId": "<string>",
          "appKey": "<string>",
          "appName": "<string>",
          "subjectType": "<string>",
          "success": true,
          "identifier": "<string>",
          "subject": "<string>",
          "verb": "<string>",
          "message": "<string>",
          "metadata": "<unknown>",
          "oldValue": "<string>",
          "newValue": "<string>",
          "amount": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "attributes": {}
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "shipmentId": "<string>",
      "trackingNumber": "<string>",
      "trackingNumbers": [
        "<string>"
      ],
      "packagingType": "<string>",
      "hasLabel": true,
      "measurements": {
        "height": {
          "unit": "<string>",
          "value": 123
        },
        "width": {
          "unit": "<string>",
          "value": 123
        },
        "length": {
          "unit": "<string>",
          "value": 123
        },
        "weight": {
          "unit": "<string>",
          "value": 123
        }
      },
      "carrier": "<string>",
      "signatureRequired": true,
      "trackings": [
        {
          "attributes": {},
          "number": "<string>",
          "url": "<string>"
        }
      ],
      "packingSlipItemDetails": [
        {
          "attributes": {},
          "lineId": 123,
          "originalOrderItemId": "<string>",
          "quantity": 123
        }
      ],
      "packingSlipNumber": 123,
      "returnTrackings": [
        {
          "attributes": {},
          "number": "<string>",
          "url": "<string>"
        }
      ],
      "returnTrackingNumbers": [
        "<string>"
      ],
      "returnCarrier": "<string>",
      "packageId": "<string>",
      "manifestId": "<string>",
      "labelFormat": "<string>",
      "integratorId": "<string>",
      "fxcbPackNotificationId": "<string>",
      "fxcbDocumentsUrl": "<string>",
      "attributes": {}
    }
  ],
  "productLossTotal": 123,
  "shippingLossTotal": 123,
  "lossTotal": 123,
  "productLossTaxTotal": 123,
  "shippingLossTaxTotal": 123,
  "tenantId": 123,
  "siteId": 123,
  "userId": "<string>",
  "channelCode": "<string>",
  "changeMessages": [
    {
      "id": "<string>",
      "correlationId": "<string>",
      "userId": "<string>",
      "userFirstName": "<string>",
      "userLastName": "<string>",
      "userScopeType": "<string>",
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "subjectType": "<string>",
      "success": true,
      "identifier": "<string>",
      "subject": "<string>",
      "verb": "<string>",
      "message": "<string>",
      "metadata": "<unknown>",
      "oldValue": "<string>",
      "newValue": "<string>",
      "amount": 123,
      "createDate": "2023-11-07T05:31:56Z",
      "attributes": {}
    }
  ],
  "actionRequired": true,
  "isUnified": true,
  "canInitiateRefund": true,
  "refundToGC": true,
  "shipOrBillCountryCode": "<string>",
  "data": {},
  "taxData": {},
  "externalId": "<string>",
  "overrideReturnRule": true,
  "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

ID of the order to add an item to.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

All properties of the new return item.

​
id
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.

​
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.

​
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.

​
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.

​
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
​
dispositionInfo
object[] | null
​
attributes
object[] | null

Collection of attributes defined for this return item.

Response

Success

​
id
string | null

Unique Identifier for this Return

​
customerAccountId
integer<int32> | null

Unique identifier of the customer account.

​
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

​
webSessionId
string | null

Identifies the web session used to place the order or last update the cart.

​
customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

​
availableActions
string[] | null

Current available actions.

​
returnNumber
integer<int32> | null

A human-facing identifier that is unique within a tenant to represent the sequential ordering of Returns.

​
contact
object
​
locationCode
string | null

Location code where the return was made/processed

​
originalOrderId
string | null

The Id of the Order that this Return was generated from.

​
originalOrderNumber
integer<int32> | null

The order number that this return was generated from.

​
returnOrderId
string | null

The Id of the Order that represents the items shipped to the shopper for this Return.

​
currencyCode
string | null

ISO Currency Code. Currently, only USD is supported.

​
status
string | null

The Status of the Return. Valid values are Null, Created, ReturnAuthorized, ReturnPending, ReturnReceived, ReplacementShipped, Cancelled, and Closed.

​
pickupDate
string<date-time> | null

Pickupdate is the date when the return was picked up by the carrier. This is optional.

​
receiveStatus
string | null

A rollup status describing whether the return items have been received. See Mozu.CommerceRuntime.Contracts.Returns.Return.ReceiveStatusConst for possible values.

​
refundStatus
string | null

A rollup status describing whether the return items have been refunded. See Mozu.CommerceRuntime.Contracts.Returns.Return.RefundStatusConst for possible values.

​
replaceStatus
string | null

A rollup status describing whether the return items have been marked as replaced. See Mozu.CommerceRuntime.Contracts.Returns.Return.ReplaceStatusConst for possible values.

​
items
object[] | null

The list of items being returned by the Shopper and replaced by the Merchant in this Return.

​
notes
object[] | null

Any Merchant Notes for this Return.

​
rmaDeadline
string<date-time> | null

The deadline for a Shopper to ship the items in this Return to the Merchant.

​
returnType
string | null

Specifies whether this Return was a Refund or a Replace

​
refundAmount
number<double> | null

If this Return was refunded, how much was credited to the shopper? This amount is summed from the refund payments.

​
auditInfo
object
​
payments
object[] | null

Any Refund payments associated with this Return.

​
packages
object[] | null

Shipping package associated with this return.

​
productLossTotal
number<double> | null

The Total Loss Amount is equal to the (cost of item) * quantity of item returned. It is meant to represent the product value to the merchant of the items damaged or returned by a shopper.

​
shippingLossTotal
number<double> | null

The Shipping Loss Total is equal to the (shipping cost of item) * quantity of item returned. It is meant to represent the product value to the merchant of the items damaged or returned by a shopper.

​
lossTotal
number<double> | null

Sum of the ProductLossTotal and the ShippingLossTotal.

​
productLossTaxTotal
number<double> | null

The Total Taxes assessed on the product loss.

​
shippingLossTaxTotal
number<double> | null

The Total Taxes assessed on the shipping loss.

​
tenantId
integer<int32> | null

Unique identifier of the Tenant.

​
siteId
integer<int32> | null

Unique identifier of the Site.

​
userId
string | null

Unique identifier of the current user.

​
channelCode
string | null

Unique identifier of the channel for this item.

​
changeMessages
object[] | null

Change messages related to the return.

​
actionRequired
boolean

To find Returns that have failed to refund.

​
isUnified
boolean

Was this return created by the Unified platform.

​
canInitiateRefund
boolean

To identify Return is refundable or not.

​
refundToGC
boolean

If this Flag is true, Refund will be done on new Gift Card.

​
shipOrBillCountryCode
string | null

ShipOrBillCountryCode contains country code of shipping address or Billing address

​
data
object

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

​
taxData
object

Storage for any additional/custom tax data.

​
externalId
string | null

A return can be created from an external system. This field is used to store the external id.

​
overrideReturnRule
boolean

When this is set to true, the return rules will be ignored, and a return will be created without any checks.

​
attributes
object[] | null

Collection of custom attributes associated with the return.