Manage refunds

Get an order's available refunds

This method gets refunds available for an order by ID. Specify the ID of the order in the {orderId} URI path parameter.

GEThttps://api.digitalriver.com/orders/{orderId}/refunds-available

Path parameters

orderId*string

The order's ID.

Response

200403404

Successful response.

Body

application/json

currencystring

The refund currency.

lineItemsarray of RefundAvailableLineItem (object)

priceRefundAvailableDetail (object)

statusstring

The current status of the refund.

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/orders/{orderId}/refunds-available', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "currency": "text",
  "lineItems": [
    {
      "lineItemId": "text",
      "price": {
        "total": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalTax": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalShipping": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalShippingTax": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalDutiesAndTariffs": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalDutiesAndTariffsTax": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalFee": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        },
        "totalFeeTax": {
          "amount": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "text"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "text"
          }
        }
      },
      "product": {
        "companyId": "text",
        "id": "text"
      },
      "status": "text"
    }
  ],
  "price": {
    "total": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalTax": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalShipping": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalShippingTax": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalDutiesAndTariffs": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalDutiesAndTariffsTax": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalFee": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    },
    "totalFeeTax": {
      "amount": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "text"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "text"
      }
    }
  },
  "status": "text"
}

Get an order's refunds

Retrieve the refunds for an order using its ID by specifying the {orderId} in the URI path parameter.

GEThttps://api.digitalriver.com/orders/{orderId}/refunds

Path parameters

orderId*string

The order's ID.

Response

200403404

Successful response.

Body

application/json

refundsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/orders/{orderId}/refunds', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "refunds": [
    {
      "id": "text",
      "status": "text",
      "reason": "text",
      "comments": "text",
      "type": "text",
      "category": "text",
      "generationDate": "text",
      "generatedBy": "text",
      "origin": "text",
      "policy": "text",
      "currency": "text"
    }
  ]
}

Create an order refund

Include the order ID in the {orderId} URI path parameter when creating a refund for an order.

POSThttps://api.digitalriver.com/orders/{orderId}/refunds

Path parameters

orderId*string

The order's ID.

Body

application/json

The Refund object.

one of

OrderLevelRefundRequest (object)ProductLevelRefundRequest (object)

Response

200400403404409

Successful response.

Body

application/json

one of

OrderLevelRefundResponse (object)ProductLevelRefundResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/orders/{orderId}/refunds', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "category": "PRODUCT_LEVEL_PRODUCT",
      "comments": "text",
      "reason": "CUSTOMER_SATISFACTION_ISSUE",
      "refundAmount": {},
      "type": "text"
    }),
});
const data = await response.json();

Response

200400403404409

{
  "refunds": [
    {
      "id": "text",
      "status": "text",
      "reason": "text",
      "comments": "text",
      "type": "text",
      "category": "text",
      "generationDate": "text",
      "generatedBy": "text",
      "origin": "text",
      "policy": "text",
      "currency": "text"
    }
  ]
}

Get the order's refund schema

Retrieve the JSON schema for an order refund by specifying the order ID in the {orderId} URI path parameter.

GEThttps://api.digitalriver.com/orders/{orderId}/refunds/schema

Path parameters

orderId*string

The order's ID.

Response

200

Successful response.

Body

application/json

RefundSchema (one of)

Line Items With FeesLine Items Without FeesOrderRefund

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/orders/{orderId}/refunds/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "text",
  "reason": "text",
  "comments": "text",
  "type": "text",
  "category": "text",
  "generationDate": "text",
  "origin": "text",
  "overrides": "text",
  "policy": "text",
  "currency": "text",
  "refundAmount": {
    "value": 0,
    "formattedValue": "text"
  },
  "lineItems": [
    {
      "status": "text",
      "expectedQuantity": 0,
      "returnedQuantity": 0,
      "type": "text",
      "notes": "text",
      "date": "text",
      "Product": {
        "companyId": "text",
        "id": "text",
        "externalId": "text"
      },
      "lineItemId": "text",
      "refundAmount": {
        "value": 0,
        "formattedValue": "text"
      },
      "lineItemFees": [
        {
          "feeType": "text",
          "refundAmount": {
            "value": 0,
            "currency": "text"
          }
        }
      ]
    }
  ],
  "id": "text",
  "companyId": "text",
  "siteId": "text"
}