Skip to main content
GET
/
commerce
/
returns
/
{returnId}
/
paymentDistribution
Error
A valid request URL is required to generate request examples
{
  "returnId": "<string>",
  "refunds": [
    {
      "paymentId": "<string>",
      "paymentType": "<string>",
      "paymentSource": "<string>",
      "amount": 123,
      "amountCollected": 123,
      "amountRefunded": 123
    }
  ],
  "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>"
          ]
        }
      ]
    }
  ],
  "defaultReturnProcessingFee": 123
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

returnId
string
required

Return Id

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

returnId
string | null
refunds
object[] | null
items
object[] | null
defaultReturnProcessingFee
number<double>