--- title: "Order Refund Schema" method: GET path: "/orders/{orderId}/refunds/schema" tags: ["Refund"] --- # Order Refund Schema `GET /orders/{orderId}/refunds/schema` Gets JSON schema for order refund ## Path parameters - `orderId` string, required ## Response `200` Successful response. - union - union - object - `status` string — The current status of the refund. - `reason` 'CUSTOMER_SATISFACTION_ISSUE' | 'DAMAGED_PRODUCT' | 'DELAYED_SHIPPING' | 'FEE_CHARGED_INCORRECTLY' | 'FEE_EXEMPT_CUSTOMER' | 'FRAUD' | 'MATCH_PROMOTIONAL_PRICE' | 'MISSING_ITEMS_FROM_ORDER' | 'NEVER_RECEIVED' | 'ORDER_PROCESSING_ERROR' | 'PHONE_ORDER_ERROR' | 'PRODUCT_SHOULD_NOT_HAVE_FEE' | 'PRODUCT_TRIALWARE' | 'TAX_EXEMPT' | 'UNABLE_TO_SHIP_TO_COUNTRY' | 'UNDELIVERABLE_ADDRESS' | 'VENDOR_APPROVED_REFUND', required — The reason for the refund. - `comments` string, required — Any comments added to this refund. - `type` 'PRODUCT_SHOULD_NOT_HAVE_FEE', required — The refund type: Product Level refund. - `category` 'PRODUCT_LEVEL_FEE', required — The refund category. - `generationDate` string — The date and time the refund was requested. - `origin` string — The requester who initiated the refund. - `overrides` string — Lists the overridden site policies for the refund request. - `policy` string — Lists the return policy for the products. - `currency` string — The refund currency. - `totalRefunded` object — The total amount that is refunded at this time. - `outstanding` object — The outstanding amount on the refund request. - `totalRequested` object — The total amount requested for the refund. - `refundAmount` Price, required - `value` number — The refund amount. - `formattedValue` string — The formatted value displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `lineItems` object[], required - `status` string — The current status of the refund. - `expectedQuantity` integer — The number of the product expected to be returned for the refund. - `returnedQuantity` integer — The actual number of the product returned for the refund. - `type` string — The type of product in the refund. - `notes` string — Any notes about the refund. - `date` string — The date of the refund. - `Product` ProductReference - `companyId` string — The company’s ID. - `id` string — The product ID. - `externalId` string — The product ID from the client side. - `lineItemId` string, required — Line item ID. - `refundAmount` Price, required - `value` number — The refund amount. - `formattedValue` string — The formatted value displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `lineItemFees` RefundLineItemFee[], required - `feeType` string, required - `refundAmount` RequestPrice, required - `value` number — The refund amount. - `currency` string — The refund currency. - `id` string — The refund’s ID. - `companyId` string — The company’s ID. - `siteId` string — The site’s ID. - `generatedBy` string — The login ID of the person who issued the refund. - object - `status` string — The current status of the refund. - `reason` 'CUSTOMER_SATISFACTION_ISSUE' | 'DAMAGED_PRODUCT' | 'DELAYED_SHIPPING' | 'FEE_CHARGED_INCORRECTLY' | 'FEE_EXEMPT_CUSTOMER' | 'FRAUD' | 'MATCH_PROMOTIONAL_PRICE' | 'MISSING_ITEMS_FROM_ORDER' | 'NEVER_RECEIVED' | 'ORDER_PROCESSING_ERROR' | 'PHONE_ORDER_ERROR' | 'PRODUCT_SHOULD_NOT_HAVE_FEE' | 'PRODUCT_TRIALWARE' | 'TAX_EXEMPT' | 'UNABLE_TO_SHIP_TO_COUNTRY' | 'UNDELIVERABLE_ADDRESS' | 'VENDOR_APPROVED_REFUND', required — The reason for the refund. - `comments` string, required — Any comments added to this refund. - `type` 'productRefund', required — The refund type: Product Level refund. - `category` 'PRODUCT_LEVEL_PRODUCT' | 'PRODUCT_LEVEL_SHIPPING' | 'PRODUCT_LEVEL_DUTIES_AND_TARIFFS', required — The refund category. - `generationDate` string — The date and time the refund was requested. - `origin` string — The requester who initiated the refund. - `overrides` string — Lists the overridden site policies for the refund request. - `policy` string — Lists the return policy for the products. - `currency` string — The refund currency. - `totalRefunded` object — The total amount that is refunded at this time. - `outstanding` object — The outstanding amount on the refund request. - `totalRequested` object — The total amount requested for the refund. - `refundAmount` Price, required - `value` number — The refund amount. - `formattedValue` string — The formatted value displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `lineItems` RefundLineItem[], required - `status` string — The current status of the refund for the product. - `expectedQuantity` integer — The number of the product expected to be returned for the refund. - `returnedQuantity` integer — The actual number of the product returned for the refund. - `type` string — The type of product in the refund. - `notes` string — Any notes about the refund. - `date` string — The date of the refund. - `Product` ProductReference - `companyId` string — The company’s ID. - `id` string — The product ID. - `externalId` string — The product ID from the client side. - `lineItemId` string, required — Line item ID. - `refundAmount` Price, required - `value` number — The refund amount. - `formattedValue` string — The formatted value displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `lineItemFees` RefundLineItemFee[] - `feeType` string, required - `refundAmount` RequestPrice, required - `value` number — The refund amount. - `currency` string — The refund currency. - `id` string — The refund’s ID. - `companyId` string — The company’s ID. - `siteId` string — The site’s ID. - `generatedBy` string — The login ID of the person who issued the refund. - OrderRefund - `id` string — The unique identifier of the refund. - `createdTime` string, date-time — Time at which the refund was created. - `orderId` string — The unique identifier of the order. - `invoiceId` string — The unique identifier of the invoice. - `currency` string — Three-letter ISO currency code. - `type` 'shipping' | 'tax' | 'duty' | 'importer_tax' — The type of refund. - `amount` number, double — The requested refund amount. - `refundedAmount` number, double — The total amount refunded. - `items` RefundItem[] - `type` 'shipping' | 'fees' | 'duty' — The type of refund. - `itemId` string — The identifier of the item. - `skuId` string — The identifier of the SKU. - `quantity` integer — The number of returned items. - `amount` number, double, nullable — The requested refund amount. - `percent` number, double, nullable — The requested refund percent. - `refundedAmount` number, double, nullable — The total amount refunded. - `reason` string — The reason for the refund. - `failureReason` string — The reason for the refund failure, if known. - `state` 'pending_information' | 'pending' | 'succeeded' | 'failed' | 'expired' — The state of the refund. - `tokenInformation` TokenInformation - `token` string — Token to use with digitalriver.js to obtain customer information required to refund charge. - `expiresTime` string, date-time — Time at which the information token expires. - `expiresTime` string, date-time — Time at which the information token expires. - `liveMode` boolean — Has the value true if the object exists in live mode or the value false if the object exists in test mode. - `charges` Charges[] - `id` string — The unique identifier of the charge - `captured` boolean — Indicates if the charge has been captured. - `refunded` boolean — Indicates if the charge has been refunded. - `refunds` RefundCharges[] - `createdTime` string, date-time — The time that the refund was created. - `amount` number, double — The amount of the refund. - `state` 'pending' | 'complete' | 'failed' — The state of the refund. - `sourceId` string — The unique identifier of the source. - `source` string — The source of the refund. - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types. --- [API](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-admin-apis/revisions/a6efafc1669c/schema)