API reference
- Getting Started with Your API
- SDKs and Toolkits
- Commerce Overview
- POSTAdd Package to Return
- POSTAuto Refund Return
- POSTCreate Payment Action For Return
- POSTCreate Return Shipment
- POSTCreate Return Shipping Order
- DELDelete Order Item
- POSTDispose Return Items
- GETGet Available Return Actions
- GETGet Item Conditions
- GETGet Payment
- GETGet Payment Distribution
- GETGet Payments
- GETGet Reasons
- GETGet Return
- PUTUpdate Return
- DELDelete Return
- GETGet Return Attributes
- PUTUpdate Return Attributes
- POSTCreate Return Attributes
- GETGet Return Item
- GETGet Return Item Attributes
- PUTUpdate Return Item Attributes
- POSTCreate Return Item Attributes
- GETGet Return Items
- POSTCreate Return Item
- GETGet Return Label
- GETGet Return Note
- PUTUpdate Return Note
- DELDelete Return Note
- GETGet Return Notes
- POSTCreate Return Note
- GETGet Return Package
- PUTUpdate Return Package
- DELDelete Return Package
- GETGet Return Package Label
- GETGet Return Shipment
- DELDelete Return Shipment
- GETGet Returns
- POSTCreate Returns
- POSTPerform Payment Action For Return
- POSTPerform Return Action
- PUTResend Return Email
- POSTRestock Return Items
A valid request URL is required to generate request examples{
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"bundledProducts": [
{
"productCode": "<string>",
"quantity": 123
}
],
"data": {},
"dispositionInfo": [
{
"condition": "<string>",
"locationCode": "<string>",
"quantity": 123,
"status": "<string>"
}
],
"excludeProductExtras": true,
"id": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"orderItemId": "<string>",
"orderItemOptionAttributeFQN": "<string>",
"orderLineId": 123,
"product": {
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"productCode": "<string>",
"productReservationId": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
},
"bundledProducts": [
{
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"productCode": "<string>",
"productReservationId": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
},
"creditValue": 123,
"deltaPrice": 123,
"imageUrl": "<string>",
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"quantity": 123
}
],
"categories": [
{
"id": 123,
"parent": {}
}
],
"condition": "<string>",
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"fulfillmentTypesSupported": [
"<string>"
],
"imageAlternateText": "<string>",
"imageUrl": "<string>",
"isRecurring": true,
"isTaxable": true,
"mfgPartNumber": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"price": {
"creditValue": 123,
"isOverRidePriceSalePrice": true,
"msrp": 123,
"price": 123,
"priceListCode": "<string>",
"priceListEntryMode": "<string>",
"salePrice": 123,
"tenantOverridePrice": 123
},
"productType": "<string>",
"productUsage": "<string>",
"properties": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"isMultiValue": true,
"name": "<string>",
"values": [
{
"stringValue": "<string>",
"value": null
}
]
}
],
"serialNumber": "<string>",
"sku": "<string>",
"upc": "<string>",
"variationProductCode": "<string>"
},
"productLossAmount": 123,
"productLossTaxAmount": 123,
"quantityReceived": 123,
"quantityRefunded": 123,
"quantityReplaced": 123,
"quantityRestockable": 123,
"quantityRestocked": 123,
"quantityShipped": 123,
"reasons": [
{
"quantity": 123,
"reason": "<string>"
}
],
"receiveStatus": "<string>",
"refundAmount": 123,
"refundStatus": "<string>",
"replaceStatus": "<string>",
"returnNotRequired": true,
"returnProcessingFeeApplied": 123,
"returnType": "<string>",
"shipmentItemId": 123,
"shipmentNumber": 123,
"shippingAndHandlingRefunded": true,
"shippingLossAmount": 123,
"shippingLossTaxAmount": 123,
"taxData": {},
"totalWithWeightedShippingAndHandling": 123,
"totalWithoutWeightedShippingAndHandling": 123
}Get Return Item
Retrieves the details of a single return item.
A valid request URL is required to generate request examples{
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"bundledProducts": [
{
"productCode": "<string>",
"quantity": 123
}
],
"data": {},
"dispositionInfo": [
{
"condition": "<string>",
"locationCode": "<string>",
"quantity": 123,
"status": "<string>"
}
],
"excludeProductExtras": true,
"id": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"orderItemId": "<string>",
"orderItemOptionAttributeFQN": "<string>",
"orderLineId": 123,
"product": {
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"productCode": "<string>",
"productReservationId": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
},
"bundledProducts": [
{
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"productCode": "<string>",
"productReservationId": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
},
"creditValue": 123,
"deltaPrice": 123,
"imageUrl": "<string>",
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"quantity": 123
}
],
"categories": [
{
"id": 123,
"parent": {}
}
],
"condition": "<string>",
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"fulfillmentTypesSupported": [
"<string>"
],
"imageAlternateText": "<string>",
"imageUrl": "<string>",
"isRecurring": true,
"isTaxable": true,
"mfgPartNumber": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"price": {
"creditValue": 123,
"isOverRidePriceSalePrice": true,
"msrp": 123,
"price": 123,
"priceListCode": "<string>",
"priceListEntryMode": "<string>",
"salePrice": 123,
"tenantOverridePrice": 123
},
"productType": "<string>",
"productUsage": "<string>",
"properties": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"isMultiValue": true,
"name": "<string>",
"values": [
{
"stringValue": "<string>",
"value": null
}
]
}
],
"serialNumber": "<string>",
"sku": "<string>",
"upc": "<string>",
"variationProductCode": "<string>"
},
"productLossAmount": 123,
"productLossTaxAmount": 123,
"quantityReceived": 123,
"quantityRefunded": 123,
"quantityReplaced": 123,
"quantityRestockable": 123,
"quantityRestocked": 123,
"quantityShipped": 123,
"reasons": [
{
"quantity": 123,
"reason": "<string>"
}
],
"receiveStatus": "<string>",
"refundAmount": 123,
"refundStatus": "<string>",
"replaceStatus": "<string>",
"returnNotRequired": true,
"returnProcessingFeeApplied": 123,
"returnType": "<string>",
"shipmentItemId": 123,
"shipmentNumber": 123,
"shippingAndHandlingRefunded": true,
"shippingLossAmount": 123,
"shippingLossTaxAmount": 123,
"taxData": {},
"totalWithWeightedShippingAndHandling": 123,
"totalWithoutWeightedShippingAndHandling": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the return whose item you want to get.
Unique identifier of the return item whose details you want to get.
Query Parameters
limits which fields are returned in the response body
Response
Success
Collection of attributes defined for this return item.
Show child attributes
Show child attributes
Deprecated. Not used.
Show child attributes
Show child attributes
Custom data for a given vendor set within the commerce process.
Show child attributes
Show child attributes
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.
The identifier of the return
Show child attributes
Show child attributes
Any merchant-supplied notes for this ReturnItem.
Show child attributes
Show child attributes
The OrderItem that this ReturnItem is associated with. Either the Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.Product or the OrderItemId must be present.
If this item refers to a product extra, provide the item's corresponding OptionAttributeFQN.
The OrderLineId that this ReturnItem is associated with. If Mozu.CommerceRuntime.Contracts.Returns.ReturnItem.OrderItemId is present, the OrderLineId should be present also.
The product as it appears on the order item.
Show child attributes
Show child attributes
The loss incurred of the returned products, used for accounting purposes.
The tax on the returned products, used for accounting purposes.
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.
The quantity of the item being refunded is specified in this field
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.
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.
Field to specify How many items added to inventory
The quantity of this item fulfilled on the parent order.
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
Show child attributes
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.
If a refund is issued for the return, how much of the refund amount is for this particular item.
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.
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.
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.
The processing fee on the item that gets persisted into the database
Specifies whether the requested resolution for this item is Refund or Replace.
The identifier of the item
Determines if shipping and handling is returned on the item
The loss incurred of the returned product shipping, used for accounting purposes.
The tax on the returned product shipping, used for accounting purposes.
Additional tax-related data for this return item.
Line item total with line item, Tax, Weighted Tax with Weighted shipping and handling costs
Taxable Subtotal including Weighted Order amounts