eBay Post-Order APIVersion 2

Create Return Request

POST /post-order/v2/return

This call creates a return request for the buyer. If you are converting a return draft into an actual return request, you must include the draftId field in the request. Whether you are creating a return request directly, or converting a return draft into a return request, you must include values for the itemId, transactionId, reason, returnQuantity, and type fields.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return?
  fieldgroups=string

URI parameters

Parameter Type Required? Meaning
fieldgroups string Optional The fieldgroups query parameter can be used in the call URI to control the detail level that is returned in response. See the GetReturnFieldGroupEnum type for more information on the values that may be used in this query parameter.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

The following lists all fields that could be included in the request.

{ /* CreateReturnRequest */
"draftId": string,
"returnRequest":
    { /* ReturnRequestType */
    "carrier": token,
    "comments":
        { /* Text */
        "content": string,
        "language": string,
        "translatedFromContent": string,
        "translatedFromLanguage": string
        },
    "itemId": string,
    "reason": string,
    "requestType": token,
    "returnQuantity": integer,
    "transactionId": string,
    "type": string
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
draftId string Conditional The unique identifier of a return draft. This field is only applicable (and required) if the buyer is converting a return draft into an actual return request with the POST /post-order/v2/return call.
returnRequest ReturnRequestType Required This container is used to provide details about the buyer's return request, including the order line item (and quantity) that is being returned, the reason for the return, and the buyer's preference to either get money back for item or to get a replacement item from the seller.
returnRequest.carrier token Optional Indicates the shipping carrier that will be used to ship the return item. ShippingCarrierEnum contains some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete list.

Applicable values: See ShippingCarrierEnum
returnRequest.comments Text Optional This optional container allows the buyer to provide more information to the seller about why the item is being returned.
returnRequest.comments.content string Conditional This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
returnRequest.comments
  .language
string Conditional This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

Applicable values are from LanguageEnum:See language.
returnRequest.comments
  .translatedFromContent
string Conditional If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
returnRequest.comments
  .translatedFromLanguage
string Conditional If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

Applicable values are from LanguageEnum:See translatedFromLanguage.
returnRequest.itemId string Required The unique identifier of a listing. The itemID and transactionId fields are required to identify the order line item for which a return (or return draft) is being requested by the buyer.
returnRequest.reason string Optional This enumerated value indicates the buyer's reason for creating a return request or draft.

Applicable values are from ReturnReasonEnum:See reason.
returnRequest.requestType token Required This enumeration value indicates if the return request is an actual return request or a return draft.

Applicable values: See RequestTypeEnum
returnRequest.returnQuantity integer Optional This integer value indicates the quantity of the line item being returned. This number is generally '1', unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing. This value defaults to '1' if this field is omitted when a return is created.
returnRequest.transactionId string Required The unique identifier of a transaction. The itemID and transactionId fields are required to identify the order line item for which a return (or return draft) is being requested by the buyer.
returnRequest.type string Optional This enumeration value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item). MONEY_BACK is the default value.

Applicable values are from ReturnTypeEnum:

CANCEL
This value is passed into the type field of the request when the buyer wants to cancel a return request (or draft).
MONEY_BACK
This value is passed into the type field of the request when the buyer is creating a return request (or draft), and wants a full refund after returning the item.
REPLACEMENT
This value is passed into the type field of the request when the buyer is creating a return request (or draft), but wants a replacement item instead of a refund.
UNKNOWN
This is the default value if the return type is not known.

Output

See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

Supported response formats: application/json, application/xml

For more information:
- See CreateReturnResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* CreateReturnResponse */
"detail":
    { /* GetDetailResponse */
    "detail":
        { /* ReturnDetailType */
        "buyerAddress":
            { /* ReturnAddressType */
            "address":
                { /* Address */
                "addressLine1": string,
                "addressLine2": string,
                "addressType": string,
                "city": string,
                "country": string,
                "county": string,
                "isTransliterated": boolean,
                "nationalRegion": string,
                "postalCode": string,
                "script": string,
                "stateOrProvince": string,
                "transliteratedFromScript": string,
                "worldRegion": string
                },
            "name": string
            },
        "buyerLoginName": string,
        "closeInfo":
            { /* ReturnCloseInfoType */
            "buyerCloseComment": string,
            "buyerCloseReason": token,
            "returnCloseReason": token
            },
        "dispositionRuleDetail": [
            { /* DispositionRuleDetailType */
            "ruleId": string,
            "ruleName": string,
            "ruleTemplate": string
            }
            /* More DispositionRuleDetailType nodes here */
          ],
        "files": [
            { /* ReturnFileType */
            "creationDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "fileData": string,
            "fileFormat": token,
            "fileId": string,
            "filePurpose": token,
            "fileStatus": token,
            "resizedFileData": string,
            "submitter": token
            }
            /* More ReturnFileType nodes here */
          ],
        "holdInfo":
            { /* ReturnHoldInfoType */
            "holdCreationDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "holdReferenceId": string,
            "holdReleaseDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "holdStatus": string,
            "holdTransactionId": string
            },
        "itemDetail":
            { /* ItemDetailType */
            "itemId": string,
            "returnQuantity": integer,
            "transactionId": string
            },
        "marketplaceId": string,
        "moneyMovementInfo": [
            { /* MoneyMovementDetailType */
            "actualAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "creationDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "externalPaymentId": string,
            "moneyMovementType": token,
            "paymentProvider": token,
            "requestedAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "status": token
            }
            /* More MoneyMovementDetailType nodes here */
          ],
        "refundInfo":
            { /* RefundInfoType */
            "actualRefundDetail":
                { /* ActualRefundDetailType */
                "actualRefund":
                    { /* RefundDetailType */
                    "itemizedRefundDetail": [
                        { /* ItemizedRefundDetailType */
                        "refundAmount":
                            { /* Amount */
                            "convertedFromCurrency": string,
                            "convertedFromValue": number,
                            "currency": string,
                            "value": number
                            },
                        "refundFeeType": string,
                        "restockingFeePercentage": string
                        }
                        /* More ItemizedRefundDetailType nodes here */
                      ],
                    "totalAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        }
                    },
                "refundInitiationType": string,
                "refundIssuedDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "refundStatus": token
                },
            "estimatedRefundDetail":
                { /* EstimatedRefundDetailType */
                "itemizedRefundDetails": [
                    { /* EstimatedRefundType */
                    "estimatedAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "maxAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "minAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "refundFeeType": string,
                    "restockingFeePercentage": string
                    }
                    /* More EstimatedRefundType nodes here */
                  ],
                "optionalRefundLineItems": [
                    { /* EstimatedRefundType */
                    "estimatedAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "maxAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "minAmount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "refundFeeType": string,
                    "restockingFeePercentage": string
                    }
                    /* More EstimatedRefundType nodes here */
                  ]
                }
            },
        "replacementShipmentInfo":
            { /* ShipmentType */
            "allShipmentTrackings": [
                { /* ShipmentTrackingType */
                "active": boolean,
                "actualDeliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "actualShipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "carrierEnum": token,
                "carrierId": integer,
                "carrierName": string,
                "carrierUsed": string,
                "deliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "deliveryStatus": string,
                "destinationAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "errorCode": string,
                "labelAvailableUntilDate": string,
                "labelDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "labelId": string,
                "labelPrintExpired": boolean,
                "labelVoidExpired": boolean,
                "markAsReceived": boolean,
                "maxDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "minDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "originAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "shipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "shipmentId": string,
                "shippedBy": token,
                "shippingMethod": string,
                "trackingNumber": string
                }
                /* More ShipmentTrackingType nodes here */
              ],
            "payee": token,
            "shipmentTracking":
                { /* ShipmentTrackingType */
                "active": boolean,
                "actualDeliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "actualShipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "carrierEnum": token,
                "carrierId": integer,
                "carrierName": string,
                "carrierUsed": string,
                "deliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "deliveryStatus": string,
                "destinationAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "errorCode": string,
                "labelAvailableUntilDate": string,
                "labelDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "labelId": string,
                "labelPrintExpired": boolean,
                "labelVoidExpired": boolean,
                "markAsReceived": boolean,
                "maxDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "minDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "originAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "shipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "shipmentId": string,
                "shippedBy": token,
                "shippingMethod": string,
                "trackingNumber": string
                },
            "shippingLabelCost":
                { /* ReturnShippingCostDetailType */
                "itemizedReturnShippingCost": [
                    { /* ItemizedReturnShippingCostType */
                    "amount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "returnShippingCostType": string
                    }
                    /* More ItemizedReturnShippingCostType nodes here */
                  ],
                "totalAmount":
                    { /* Amount */
                    "convertedFromCurrency": string,
                    "convertedFromValue": number,
                    "currency": string,
                    "value": number
                    }
                }
            },
        "responseHistory": [
            { /* ReturnResponseHistoryType */
            "activity": token,
            "attributes":
                { /* ResponseHistoryAttributesType */
                "carrierUsed": string,
                "escalateReason": token,
                "moneyMovementRef":
                    { /* MoneyMovementRef */
                    "idref": string
                    },
                "partialRefundAmount":
                    { /* Amount */
                    "convertedFromCurrency": string,
                    "convertedFromValue": number,
                    "currency": string,
                    "value": number
                    },
                "RMA": string,
                "sellerReturnAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "toEmailAddress": string,
                "trackingNumber": string
                },
            "author": token,
            "creationDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "fromState": token,
            "notes": string,
            "toState": token
            }
            /* More ReturnResponseHistoryType nodes here */
          ],
        "returnShipmentInfo":
            { /* ShipmentType */
            "allShipmentTrackings": [
                { /* ShipmentTrackingType */
                "active": boolean,
                "actualDeliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "actualShipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "carrierEnum": token,
                "carrierId": integer,
                "carrierName": string,
                "carrierUsed": string,
                "deliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "deliveryStatus": string,
                "destinationAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "errorCode": string,
                "labelAvailableUntilDate": string,
                "labelDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "labelId": string,
                "labelPrintExpired": boolean,
                "labelVoidExpired": boolean,
                "markAsReceived": boolean,
                "maxDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "minDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "originAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "shipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "shipmentId": string,
                "shippedBy": token,
                "shippingMethod": string,
                "trackingNumber": string
                }
                /* More ShipmentTrackingType nodes here */
              ],
            "payee": token,
            "shipmentTracking":
                { /* ShipmentTrackingType */
                "active": boolean,
                "actualDeliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "actualShipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "carrierEnum": token,
                "carrierId": integer,
                "carrierName": string,
                "carrierUsed": string,
                "deliveryDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "deliveryStatus": string,
                "destinationAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "errorCode": string,
                "labelAvailableUntilDate": string,
                "labelDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "labelId": string,
                "labelPrintExpired": boolean,
                "labelVoidExpired": boolean,
                "markAsReceived": boolean,
                "maxDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "minDeliveryEstimate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "originAddress":
                    { /* ReturnAddressType */
                    "address":
                        { /* Address */
                        "addressLine1": string,
                        "addressLine2": string,
                        "addressType": string,
                        "city": string,
                        "country": string,
                        "county": string,
                        "isTransliterated": boolean,
                        "nationalRegion": string,
                        "postalCode": string,
                        "script": string,
                        "stateOrProvince": string,
                        "transliteratedFromScript": string,
                        "worldRegion": string
                        },
                    "name": string
                    },
                "shipDate":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "shipmentId": string,
                "shippedBy": token,
                "shippingMethod": string,
                "trackingNumber": string
                },
            "shippingLabelCost":
                { /* ReturnShippingCostDetailType */
                "itemizedReturnShippingCost": [
                    { /* ItemizedReturnShippingCostType */
                    "amount":
                        { /* Amount */
                        "convertedFromCurrency": string,
                        "convertedFromValue": number,
                        "currency": string,
                        "value": number
                        },
                    "returnShippingCostType": string
                    }
                    /* More ItemizedReturnShippingCostType nodes here */
                  ],
                "totalAmount":
                    { /* Amount */
                    "convertedFromCurrency": string,
                    "convertedFromValue": number,
                    "currency": string,
                    "value": number
                    }
                }
            },
        "RMANumber": string,
        "sellerAddress":
            { /* ReturnAddressType */
            "address":
                { /* Address */
                "addressLine1": string,
                "addressLine2": string,
                "addressType": string,
                "city": string,
                "country": string,
                "county": string,
                "isTransliterated": boolean,
                "nationalRegion": string,
                "postalCode": string,
                "script": string,
                "stateOrProvince": string,
                "transliteratedFromScript": string,
                "worldRegion": string
                },
            "name": string
            },
        "sellerLoginName": string
        },
    "summary":
        { /* ReturnSummaryType */
        "buyerAvailableOptions": [
            { /* AvailableOptionType */
            "actionType": token,
            "actionURL": string
            }
            /* More AvailableOptionType nodes here */
          ],
        "buyerLoginName": string,
        "buyerResponseDue":
            { /* ReturnResponseDueType */
            "activityDue": token,
            "respondByDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                }
            },
        "buyerTotalRefund":
            { /* TotalRefundAmountType */
            "actualRefundAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "estimatedRefundAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                }
            },
        "creationInfo":
            { /* ReturnCreationInfoType */
            "comments":
                { /* Text */
                "content": string,
                "language": string,
                "translatedFromContent": string,
                "translatedFromLanguage": string
                },
            "creationDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "item":
                { /* ReturnItemType */
                "itemId": string,
                "returnQuantity": integer,
                "transactionId": string
                },
            "reason": string,
            "type": string
            },
        "currentType": string,
        "dispositionRuleTriggered": [
            string
            /* More string nodes here */
          ],
        "escalationInfo":
            { /* EscalationInfoType */
            "buyerEscalationEligibilityInfo":
                { /* EscalationEligibilityInfo */
                "eligible": boolean,
                "endTime":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "startTime":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    }
                },
            "caseId": string,
            "sellerEscalationEligibilityInfo":
                { /* EscalationEligibilityInfo */
                "eligible": boolean,
                "endTime":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "startTime":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    }
                }
            },
        "returnId": string,
        "returnPolicy":
            { /* ReturnPolicyType */
            "RMARequired": boolean
            },
        "sellerAvailableOptions": [
            { /* AvailableOptionType */
            "actionType": token,
            "actionURL": string
            }
            /* More AvailableOptionType nodes here */
          ],
        "sellerLoginName": string,
        "sellerResponseDue":
            { /* ReturnResponseDueType */
            "activityDue": token,
            "respondByDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                }
            },
        "sellerTotalRefund":
            { /* TotalRefundAmountType */
            "actualRefundAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "estimatedRefundAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                }
            },
        "state": token,
        "status": token
        }
    },
"eligibilityResult":
    { /* ReturnEligibilityPerItemType */
    "eligibilityResultsPerCheckType": [
        { /* ReturnEligibilityItemPerCheckTypeResult */
        "checkType": string,
        "eligibilityInfo":
            { /* EligibilityResultType */
            "caseId": string,
            "eligibilityErrorDetail": [
                { /* ReturnEligibilityErrorDetailType */
                "eligibilityError":
                    { /* EligibilityErrorType */
                    "code": string,
                    "content": string,
                    "description": string
                    }
                }
                /* More ReturnEligibilityErrorDetailType nodes here */
              ],
            "eligibilityStatus": string,
            "eligibleStartDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "returnCreationDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "returnDeadline":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "returnId": string
            }
        }
        /* More ReturnEligibilityItemPerCheckTypeResult nodes here */
      ],
    "returnItem":
        { /* ReturnEligibilityItemType */
        "itemId": string,
        "reason": string,
        "returnQuantity": integer,
        "transactionId": string
        }
    },
"returnId": string,
"summary":
    { /* ReturnSummaryType */
    "buyerAvailableOptions": [
        { /* AvailableOptionType */
        "actionType": token,
        "actionURL": string
        }
        /* More AvailableOptionType nodes here */
      ],
    "buyerLoginName": string,
    "buyerResponseDue":
        { /* ReturnResponseDueType */
        "activityDue": token,
        "respondByDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            }
        },
    "buyerTotalRefund":
        { /* TotalRefundAmountType */
        "actualRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "estimatedRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            }
        },
    "creationInfo":
        { /* ReturnCreationInfoType */
        "comments":
            { /* Text */
            "content": string,
            "language": string,
            "translatedFromContent": string,
            "translatedFromLanguage": string
            },
        "creationDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "item":
            { /* ReturnItemType */
            "itemId": string,
            "returnQuantity": integer,
            "transactionId": string
            },
        "reason": string,
        "type": string
        },
    "currentType": string,
    "dispositionRuleTriggered": [
        string
        /* More string nodes here */
      ],
    "escalationInfo":
        { /* EscalationInfoType */
        "buyerEscalationEligibilityInfo":
            { /* EscalationEligibilityInfo */
            "eligible": boolean,
            "endTime":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "startTime":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                }
            },
        "caseId": string,
        "sellerEscalationEligibilityInfo":
            { /* EscalationEligibilityInfo */
            "eligible": boolean,
            "endTime":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "startTime":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                }
            }
        },
    "returnId": string,
    "returnPolicy":
        { /* ReturnPolicyType */
        "RMARequired": boolean
        },
    "sellerAvailableOptions": [
        { /* AvailableOptionType */
        "actionType": token,
        "actionURL": string
        }
        /* More AvailableOptionType nodes here */
      ],
    "sellerLoginName": string,
    "sellerResponseDue":
        { /* ReturnResponseDueType */
        "activityDue": token,
        "respondByDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            }
        },
    "sellerTotalRefund":
        { /* TotalRefundAmountType */
        "actualRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "estimatedRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            }
        },
    "state": token,
    "status": token
    }
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
detail GetDetailResponse Conditionally This container consists of detailed information on the return item. This container will not be returned if the fieldGroups query parameter is used and its value is set to SUMMARY or NONE.
detail.detail ReturnDetailType Conditionally This container consists of detailed information on the order line item that is associated with the return request. This container is not returned if the fieldgroups query parameter is omitted, or if it is used and its value is set to SUMMARY or NONE.
detail.detail.buyerAddress ReturnAddressType Conditionally This container provides the buyer's default shipping address.
detail.detail.buyerAddress
  .address
Address Conditionally This container holds the address of the named party.
detail.detail.buyerAddress
  .address.addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail.buyerAddress
  .address.addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail.buyerAddress
  .address.addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail.buyerAddress
  .address.city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail.buyerAddress
  .address.country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail.buyerAddress
  .address.county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail.buyerAddress
  .address.isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail.buyerAddress
  .address.nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail.buyerAddress
  .address.postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail.buyerAddress
  .address.script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail.buyerAddress
  .address.stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail.buyerAddress
  .address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail.buyerAddress
  .address.worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail.buyerAddress
  .name
string Conditionally The identity of the party associated with this address.
detail.detail.buyerLoginName string Conditionally This string value is the eBay user name of the buyer.
detail.detail.closeInfo ReturnCloseInfoType Conditionally This container provides information on the buyer's reason for wanting to close the return and the actual reason why the return was closed.
detail.detail.closeInfo
  .buyerCloseComment
string Conditionally This string field holds the comment that the buyer made when closing the return request. This field is only returned if the return request was closed and the buyer made a comment upon closing the return request.
detail.detail.closeInfo
  .buyerCloseReason
token Conditionally This token indicates the reason that the buyer is closing the return request. A buyer would typically close a return request after they receive a refund, a replacement item, or if they initiated the return request by mistake. This field is only returned if the return request was closed.

Applicable values: See BuyerCloseReturnReasonEnum
detail.detail.closeInfo
  .returnCloseReason
token Conditionally This enumerated value indicates the reason that the return request is being closed. This field is only returned if the return request was closed.

Applicable values: See CloseReturnReasonEnum
detail.detail
  .dispositionRuleDetail
array of DispositionRuleDetailType Conditionally This container provides information on the case disposition (if a decision has been made on the case).
detail.detail
  .dispositionRuleDetail.ruleId
string Conditionally The unique identifier of the disposition rule.
detail.detail
  .dispositionRuleDetail
  .ruleName
string Conditionally This string value is the name of the disposition rule.
detail.detail
  .dispositionRuleDetail
  .ruleTemplate
string Conditionally This enumeration value indicates the type of disposition rule being used.

Applicable values are from DispositionRuleTemplateTypeEnum:

AUTO_REFUND_NO_SHIPBACK
Indicates the auto-refund with no return shipping disposition rule template will be used.
AUTO_ROUTE
Indicates the auto-route disposition rule template will be used.
OTHER
Indicates another disposition rule template will be used.
SEND_REPLACEMENT_NO_SHIPBACK
Indicates the replacement item with no return shipping disposition rule template will be used.

Code so that your app gracefully handles any future changes to this list.
detail.detail.files array of ReturnFileType Conditionally An array of one or more files attached to a return request.
detail.detail.files
  .creationDate
DateTime Conditionally This timestamp indicates when the file was attached to the return request or draft.
detail.detail.files
  .creationDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail.files
  .creationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail.files.fileData string Conditionally This field is the base64-encoded binary representation of the file associated with the return request. This field is always returned for each file that is attached to a return request or draft.
detail.detail.files.fileFormat token Conditionally Indicates the file type (like .GIF or .JPG). This field is always returned for each file that is attached to a return request or draft.

Applicable values: See FileFormatEnum
detail.detail.files.fileId string Conditionally This is the unique identifier of a file that is associated with the return request. This field is always returned for each file that is attached to a return request or draft.
detail.detail.files
  .filePurpose
token Conditionally Indicates whether the file's purpose is to provide more information about the condition of the item, or about shipment tracking or the shipping label. This field is always returned for each file that is attached to a return request or draft.

Applicable values: See FilePurposeEnum
detail.detail.files.fileStatus token Conditionally Indicates the current status of the file. This field is always returned for each file that is attached to a return request or draft.

Applicable values: See FileStatusEnum
detail.detail.files
  .resizedFileData
string Conditionally This field is the base64-encoded binary representation of the file associated with the return request. This field is always returned for each file that is attached to a return request or draft. This field is only returned if the file has been resized.
detail.detail.files.submitter token Conditionally Indicates which party (like buyer or seller) submitted the file. This field is always returned for each file that is attached to a return request or draft.

Applicable values: See ReturnUserRoleEnum
detail.detail.holdInfo ReturnHoldInfoType Conditionally This container provides information on a hold that has been placed on the seller's funds. This container will only be returned if a hold has been placed on the seller's funds.
detail.detail.holdInfo
  .holdCreationDate
DateTime Conditionally This timestamp indicates the date/time when the hold on the return request was initiated.
detail.detail.holdInfo
  .holdCreationDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail.holdInfo
  .holdCreationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail.holdInfo
  .holdReferenceId
string Conditionally This string value is the unique identifier of the hold on the return request.
detail.detail.holdInfo
  .holdReleaseDate
DateTime Conditionally This timestamp indicates the date/time when the hold on the return request is expected to get released.
detail.detail.holdInfo
  .holdReleaseDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail.holdInfo
  .holdReleaseDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail.holdInfo
  .holdStatus
string Conditionally This enumerated value indicates the current status of the hold on the return request.

Applicable values are from ReturnHoldStatusEnum:

HOLD_CREATION_SUCCESS
Indicates the hold placed on the return was created successfully.
HOLD_RELEASE_FAILED
Indicates the attempt to release the hold on the return failed.
HOLD_RELEASE_SUCCESS
Indicates the hold on the return was released successfully.
INELIGIBLE_TO_RELEASE_HOLD
Indicates the hold on the return is not yet eligible to be released.
OTHER
Indicates the status of the hold on the return is not classified or is unknown.

Code so that your app gracefully handles any future changes to this list.
detail.detail.holdInfo
  .holdTransactionId
string Conditionally This string value is the unique identifier of the transaction that is a part of the return request.
detail.detail.itemDetail ItemDetailType Always This container consists of information about the item, including listing ID, order line item ID, price, transaction date, and quantity being returned.
detail.detail.itemDetail
  .itemId
string Always This is the unique identifier of the listing. The itemId and transactionId pair identify the order line item associated with the return request.
detail.detail.itemDetail
  .returnQuantity
integer Always This integer value indicates the quantity of the line item being returned. This number is generally 1, unless the buyer bought multiple quantity of the line item in a multiple-quantity, fixed-price listing.
detail.detail.itemDetail
  .transactionId
string Always This is the unique identifier of the transaction. The itemId and transactionId pair identify the order line item associated with the return request.
detail.detail.marketplaceId string Conditionally The unique identifier of the eBay site, such as 'EBAY_US'.

Applicable values are from MarketplaceIdEnum:See marketplaceId.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .moneyMovementInfo
array of MoneyMovementDetailType Conditionally This container consists of detailed information on a money movement transaction. A moneyMovementInfo container is returned for each separate money movement transaction.
detail.detail
  .moneyMovementInfo
  .actualAmount
Amount Conditionally This dollar value is the actual amount of the monetary transaction. The actualAmount field will only show up if the monetary transaction was confirmed to be successful (moneyMovementStatusType values shows as 'SUCCESS'. Until then, expected amount of the monetary transaction can be seen in the requestedAmount field.
detail.detail
  .moneyMovementInfo
  .actualAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .moneyMovementInfo
  .actualAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail
  .moneyMovementInfo
  .actualAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .moneyMovementInfo
  .actualAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail
  .moneyMovementInfo
  .creationDate
DateTime Conditionally This timestamp indicates the date/time when the monetary transaction occurred.
detail.detail
  .moneyMovementInfo
  .creationDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .moneyMovementInfo
  .creationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .moneyMovementInfo
  .externalPaymentId
string Conditionally This string value is the unique identifier of the PayPal (or other payment provider) transaction.
detail.detail
  .moneyMovementInfo
  .moneyMovementType
token Conditionally Indicates the type of monetary transaction that has, or is in the process of being executed. Monetary transactions include a seller's partial or full refund to the buyer, or the seller receiving the Final Value Fee refund from eBay.

Applicable values: See MoneyMovementTypeEnum
detail.detail
  .moneyMovementInfo
  .paymentProvider
token Conditionally Indicates the external payment system used for the monetary transaction. For all other payment providers except PayPal, this value will be 'OTHER'.

Applicable values: See PaymentProviderEnum
detail.detail
  .moneyMovementInfo
  .requestedAmount
Amount Conditionally This dollar value is the expected amount of the monetary transaction. This field should always be present, regardless of the value shown in the moneyMovementStatusType field. The actualAmount field will only show up if the monetary transaction was confirmed to be successful (moneyMovementStatusType value shows as 'SUCCESS'.
detail.detail
  .moneyMovementInfo
  .requestedAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .moneyMovementInfo
  .requestedAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail
  .moneyMovementInfo
  .requestedAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .moneyMovementInfo
  .requestedAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail
  .moneyMovementInfo.status
token Conditionally Indicates the success or failure of the monetary transaction type noted in the moneyMovementType field.

Applicable values: See MoneyMovementStatusEnum
detail.detail.refundInfo RefundInfoType Conditionally This container consists of detailed information on the estimated and actual refund amounts.
detail.detail.refundInfo
  .actualRefundDetail
ActualRefundDetailType Conditionally This container shows the itemized refund information after the seller issues a refund to the buyer. This container is only returned if the seller has issued a refund to the buyer. Until the refund is actually successfully processed, only information on the estimated refund may be seen in the estimatedRefundDetail container.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
RefundDetailType Conditionally This container consists of one or more itemizedRefundDetail containers, as well as the total amount of the actual refund (which is the total of each itemizedRefundDetail.amount value). This container is only returned if a refund has been issued for the return request.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
array of ItemizedRefundDetailType Conditionally This container is used to declare a refund that is being issued, or has been issued to the buyer. An itemizedRefundDetail container is required for each different refund type, such as purchase price and original shipping. This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund call to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent call to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls, this container will be returned under the actualRefund container if a refund has occurred.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .refundAmount
Amount Conditionally This dollar value is the amount of the refund for the particular refund type (specified in the refundFeeType field). When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable).
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .refundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .refundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .refundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .refundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .refundFeeType
string Conditionally This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable).

Applicable values are from RefundFeeTypeEnum:See refundFeeType.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund
  .itemizedRefundDetail
  .restockingFeePercentage
string Conditionally Indicates the restocking fee (as a percentage of the purchase price) charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.

To obtain the list of applicable values, call GeteBayDetails of the Trading API with the DetailName field value set to ReturnPolicyDetails. Then look for the list of restocking fee value options in the ReturnPolicyDetails.RestockingFeeValue container in the response.

This field is only applicable (and necessary to include in the request payload) if the refundFeeType value is RESTOCKING_FEE.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund.totalAmount
Amount Conditionally This value is the total cumulative amount of the refund issued to the buyer. This value should equal the sum of the values in the itemizedRefundDetail.refundAmount field(s). This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund call to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent call to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls, this container will be returned under the actualRefund container if a refund has occurred.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund.totalAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund.totalAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund.totalAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .actualRefundDetail
  .actualRefund.totalAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .actualRefundDetail
  .refundInitiationType
string Conditionally This enumerated value indicates the initiator of the refund. 'SELLER_INITIATED' indicates that the seller initiated the refund, and 'AUTO_REFUND' indicates that the buyer's money was automatically refunded through the PayPal system.

Applicable values are from ReturnRefundInitiatorEnum:

AUTO_REFUND
This enumeration value indicates that the buyer was automatically refunded through the PayPal system.
OTHER
This enumeration value indicates that that initiator of the refund is unknown.
SELLER_INITIATED
This enumeration value indicates that the refund was initiated by the seller.

Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .actualRefundDetail
  .refundIssuedDate
DateTime Conditionally This timestamp indicates when the seller issued the refund to the buyer.
detail.detail.refundInfo
  .actualRefundDetail
  .refundIssuedDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail.refundInfo
  .actualRefundDetail
  .refundIssuedDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail.refundInfo
  .actualRefundDetail
  .refundStatus
token Conditionally The value in this field indicates whether or not the refund operation was successful. If the 'PENDING' value is returned, it indicates that the refund is happening outside of PayPal and there is no way for eBay to check the status of the refund. In this scenario, the seller should call POST /post-order/v2/return/{returnId}/mark_refund_sent to mark the refund as sent and/or the buyer should call POST /post-order/v2/return/{returnId}/mark_refund_received to mark the refund as received.

Applicable values: See RefundStatusEnum
detail.detail.refundInfo
  .estimatedRefundDetail
EstimatedRefundDetailType Always This container shows estimated refund information for the buyer. There will be one itemizedRefundDetail container returned under this container for each refund fee type (such as purchase price and original shipping).
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
array of EstimatedRefundType Conditionally This container shows the estimated refund information before the seller issues a refund to the buyer.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .estimatedAmount
Amount Always This dollar value is the estimated amount of the refund.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .estimatedAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .estimatedAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .estimatedAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .estimatedAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .maxAmount
Amount Always This dollar value is the maximum amount that the refund could be based on the cost of the order.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .maxAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .maxAmount.convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .maxAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .maxAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .minAmount
Amount Always This dollar value is the minimum amount that the refund could be based on the cost of the order.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .minAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .minAmount.convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .minAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .minAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .refundFeeType
string Always This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable).

Applicable values are from RefundFeeTypeEnum:See refundFeeType.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .restockingFeePercentage
string Always Indicates the restocking fee charged by the seller for returned items (if any). In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy when listing the item.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
array of EstimatedRefundType Conditionally This container shows the optional refund information that the seller can issue to the buyer at his/her discretion. The seller is not obligated to issue this type of refund, but might do so as a matter of good customer service.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .estimatedAmount
Amount Always This dollar value is the estimated amount of the refund.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .estimatedAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .estimatedAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .estimatedAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .estimatedAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .maxAmount
Amount Always This dollar value is the maximum amount that the refund could be based on the cost of the order.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .maxAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .maxAmount.convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .maxAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .maxAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .minAmount
Amount Always This dollar value is the minimum amount that the refund could be based on the cost of the order.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .minAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .minAmount.convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .minAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .minAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .refundFeeType
string Always This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable).

Applicable values are from RefundFeeTypeEnum:See refundFeeType.
Code so that your app gracefully handles any future changes to this list.
detail.detail.refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .restockingFeePercentage
string Always Indicates the restocking fee charged by the seller for returned items (if any). In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy when listing the item.
detail.detail
  .replacementShipmentInfo
ShipmentType Conditionally This container consists of detailed information on shipment of a replacement item, including shipment information (return address, shipment tracking, estimated and actual delivery dates, and delivery status), and shipping costs.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
array of ShipmentTrackingType Conditionally This container is an array of shipment tracking information for one or more items.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings.active
boolean Conditionally This boolean indicates whether or not a return request is still in an active state.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .actualDeliveryDate
DateTime Conditionally This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as DELIVERED.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .actualDeliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .actualDeliveryDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .actualShipDate
DateTime Conditionally This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .actualShipDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .actualShipDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .carrierEnum
token Conditionally Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values.

Applicable values: See ShippingCarrierEnum
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .carrierId
integer Conditionally This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .carrierName
string Conditionally This field is used to show the name of the shipping carrier. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .carrierUsed
string Conditionally This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .deliveryDate
DateTime Conditionally This field has been replaced by actualDeliveryDate.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .deliveryDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .deliveryDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .deliveryStatus
string Conditionally This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded.

Applicable values are from TrackingStatusEnum:

canceled
Indicates the current shipment tracking information has been canceled.
CREATED
Indicates shipment tracking has been initiated.
DELIVERED
Indicates the item was delivered according to the shipment tracking history.
IN_TRANSIT
Indicates the item is in-transit to the recipient according to the shipment tracking history.
UNKNOWN
Indicates shipment tracking status of the item is unknown.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped to.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .destinationAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .errorCode
string Conditionally This field is only returned if the user encountered an error when trying to provide shipment tracking information.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .labelAvailableUntilDate
string Conditionally This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .labelDate
DateTime Conditionally This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .labelDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .labelDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings.labelId
string Conditionally This string value is the unique identifier of the shipping label. This field is returned if a shipping label exists for the order line item.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .labelPrintExpired
boolean Conditionally This boolean field will be returned as true if the shipping label has expired and is no longer valid to print and use for shipping.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .labelVoidExpired
boolean Conditionally This boolean field will be returned as true if the initiator of the shipping label no longer has the ability to void the shipping label.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .markAsReceived
boolean Conditionally This boolean will be returned as true if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .maxDeliveryEstimate
DateTime Conditionally This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .maxDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .maxDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .minDeliveryEstimate
DateTime Conditionally This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .minDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .minDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped from.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address.city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address.country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address.county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address.script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .originAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings.shipDate
DateTime Conditionally This field has been replaced by the actualShipDate field.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings.shipDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings.shipDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .shipmentId
string Conditionally This string value is the unique identifier of the shipment. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .shippedBy
token Conditionally Indicates the party shipping the item, such as buyer or seller.

Applicable values: See ReturnUserRoleEnum
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .shippingMethod
string Conditionally This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.

Applicable values are from ShippingMethodEnum:

SELF_MAIL
Indicates the buyer or seller handled the shipping of an item on their own, and did not use an eBay shipping label.
SHIPPING_LABEL
Indicates the buyer or seller used an eBay shipping label to ship an item.
UNKNOWN
Indicates it is unknown whether the buyer or seller used an eBay shipping label to ship an item, or handled the shipping on their own.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .allShipmentTrackings
  .trackingNumber
string Conditionally This value is the tracking number of the shipment. This field is returned if shipment tracking has been uploaded.
detail.detail
  .replacementShipmentInfo.payee
token Conditionally Indicates the party whom is paying for shipping the item, such as buyer or seller.

Applicable values: See ReturnUserRoleEnum
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
ShipmentTrackingType Conditionally This container provides detailed information on the whereabouts of a shipped item, including tracking number, origin and destination address, shipping status, estimated and actual shipping and delivery dates, and more.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.active
boolean Conditionally This boolean indicates whether or not a return request is still in an active state.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .actualDeliveryDate
DateTime Conditionally This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as DELIVERED.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .actualDeliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .actualDeliveryDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .actualShipDate
DateTime Conditionally This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .actualShipDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .actualShipDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.carrierEnum
token Conditionally Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values.

Applicable values: See ShippingCarrierEnum
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.carrierId
integer Conditionally This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.carrierName
string Conditionally This field is used to show the name of the shipping carrier. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.carrierUsed
string Conditionally This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.deliveryDate
DateTime Conditionally This field has been replaced by actualDeliveryDate.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.deliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.deliveryDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .deliveryStatus
string Conditionally This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded.

Applicable values are from TrackingStatusEnum:

canceled
Indicates the current shipment tracking information has been canceled.
CREATED
Indicates shipment tracking has been initiated.
DELIVERED
Indicates the item was delivered according to the shipment tracking history.
IN_TRANSIT
Indicates the item is in-transit to the recipient according to the shipment tracking history.
UNKNOWN
Indicates shipment tracking status of the item is unknown.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped to.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .destinationAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.errorCode
string Conditionally This field is only returned if the user encountered an error when trying to provide shipment tracking information.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .labelAvailableUntilDate
string Conditionally This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.labelDate
DateTime Conditionally This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.labelDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.labelDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.labelId
string Conditionally This string value is the unique identifier of the shipping label. This field is returned if a shipping label exists for the order line item.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .labelPrintExpired
boolean Conditionally This boolean field will be returned as true if the shipping label has expired and is no longer valid to print and use for shipping.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .labelVoidExpired
boolean Conditionally This boolean field will be returned as true if the initiator of the shipping label no longer has the ability to void the shipping label.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .markAsReceived
boolean Conditionally This boolean will be returned as true if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .maxDeliveryEstimate
DateTime Conditionally This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .maxDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .maxDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .minDeliveryEstimate
DateTime Conditionally This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .minDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .minDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped from.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address.city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address.country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address.county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address.script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .originAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.shipDate
DateTime Conditionally This field has been replaced by the actualShipDate field.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.shipDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.shipDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.shipmentId
string Conditionally This string value is the unique identifier of the shipment. This field is returned if available.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking.shippedBy
token Conditionally Indicates the party shipping the item, such as buyer or seller.

Applicable values: See ReturnUserRoleEnum
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .shippingMethod
string Conditionally This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.

Applicable values are from ShippingMethodEnum:

SELF_MAIL
Indicates the buyer or seller handled the shipping of an item on their own, and did not use an eBay shipping label.
SHIPPING_LABEL
Indicates the buyer or seller used an eBay shipping label to ship an item.
UNKNOWN
Indicates it is unknown whether the buyer or seller used an eBay shipping label to ship an item, or handled the shipping on their own.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shipmentTracking
  .trackingNumber
string Conditionally This value is the tracking number of the shipment. This field is returned if shipment tracking has been uploaded.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
ReturnShippingCostDetailType Conditionally This container provide the itemized list of shipping costs and how much it costs to purchase the shipping label to ship an item.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
array of ItemizedReturnShippingCostType Conditionally This container consists of the shipping cost to return ship an item. An itemizedReturnShippingCost container is required for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount
Amount Conditionally This dollar value indicates the amount for the shipping cost type shown in the returnShippingCostType field.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .returnShippingCostType
string Conditionally This enumerated value indicates the type of shipping cost, such as the cost of the shipping label, shipping insurance, or the signature confirmation service.

Applicable values are from ReturnShippingCostType:

INSURANCE
Indicates the shipping cost is the price of shipping insurance if it used to return ship the item back to the seller.
LABEL_COST
Indicates the shipping cost is the price of the shipping label to return the item to the seller.
OTHER
Indicates the shipping cost is not classified or is not known.
SIGNATURE_CONFIRMATION_COST
Indicates the shipping cost is the price to return ship the item to the seller using certified shipping.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost.totalAmount
Amount Conditionally This value is the total amount of shipping costs associated with return shipping the item. This value should equal the sum of the values in the itemizedReturnShippingCost.amount field(s).
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost.totalAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost.totalAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost.totalAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .replacementShipmentInfo
  .shippingLabelCost.totalAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.responseHistory array of ReturnResponseHistoryType Conditionally This container consists of detailed information of each activity that occurs with a return request. A responseHistory container is returned for each return request activity.
detail.detail.responseHistory
  .activity
token Conditionally This token indicates the action performed by the buyer or seller to move the return request to the next stage. This field is always returned with the responseHistory container.

Applicable values: See ActivityOptionEnum
detail.detail.responseHistory
  .attributes
ResponseHistoryAttributesType Conditionally This container consists of various return shipping and refund information, such as shipping carrier, tracking number, a partial refund amount (if applicable), and a money movement transaction identifier (if applicable). This container will be returned if the the buyer/seller action (specified in the activity field) requires the data in this container.
detail.detail.responseHistory
  .attributes.carrierUsed
string Conditionally This string value indicates the shipping carrier used by the buyer. This field is not returned if this particular return activity (identified in the responseHistory.activity field) did not involve shipping.
detail.detail.responseHistory
  .attributes.escalateReason
token Conditionally Indicates why the buyer or seller escalated the return request to a return case. This field is only returned if a return request was escalated to a return case.

Applicable values: See EscalateReasonEnum
detail.detail.responseHistory
  .attributes.moneyMovementRef
MoneyMovementRef Conditionally This container provides the unique identifier of the money movement transaction. This value may be the PayPal transaction ID, or another ID if the money movement transaction did not happen in the PayPal system. This container is not returned if no money movement transaction occurred for this particular return activity (identified in the responseHistory.activity field).
detail.detail.responseHistory
  .attributes.moneyMovementRef
  .idref
string Conditionally This string value is the unique identifier of the money movement transaction. This value may be the PayPal transaction ID, or another ID if the money movement transaction did not happen in the PayPal system.
detail.detail.responseHistory
  .attributes
  .partialRefundAmount
Amount Conditionally This dollar value is the partial refund amount that the seller is offering to the buyer in order to settle the return request. This field is not applicable and not returned if the seller is not offering the buyer a partial refund.
detail.detail.responseHistory
  .attributes
  .partialRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .partialRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail.responseHistory
  .attributes
  .partialRefundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .partialRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.responseHistory
  .attributes.RMA
string Conditionally This field shows the return merchandise authorization (RMA) number for the return. This field is only returned if an RMA is associated with the return request.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress
ReturnAddressType Conditionally This container consists of the seller's return address. This container is generally returned if the buyer will be returning an item to the seller.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail.responseHistory
  .attributes
  .sellerReturnAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail.responseHistory
  .attributes.toEmailAddress
string Conditionally This string value is the email address of the applicable eBay party (the responseHistory.author field identifies this party, such as buyer, seller, eBay).
detail.detail.responseHistory
  .attributes.trackingNumber
string Conditionally This value is the tracking number of the return shipment. Providing a tracking number is mandatory except in countries where shipment tracking is not available. This field is not returned if this particular return activity (identified in the responseHistory.activity field) did not involve shipping.
detail.detail.responseHistory
  .author
token Conditionally Indicates the actor (such as buyer, seller, or eBay) that performed the action (specified in the activity field). This field is always returned with the responseHistory container.

Applicable values: See ReturnUserRoleEnum
detail.detail.responseHistory
  .creationDate
DateTime Conditionally This timestamp indicates the date/time when the action (specified in the activity field) was performed. This field is always returned with the responseHistory container.
detail.detail.responseHistory
  .creationDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail.responseHistory
  .creationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail.responseHistory
  .fromState
token Conditionally Indicates the previous state of the return before the action (specified in the activity field) was performed. This field is always returned with the responseHistory container.

Applicable values: See ReturnStateEnum
detail.detail.responseHistory
  .notes
string Conditionally This string value is a note about the buyer/seller action (specified in the activity field). This field is only returned if a note exist for the action.
detail.detail.responseHistory
  .toState
token Conditionally Indicates the new state of the return after the action (specified in the activity field) was performed. This field is always returned with the responseHistory container.

Applicable values: See ReturnStateEnum
detail.detail
  .returnShipmentInfo
ShipmentType Conditionally This container consists of detailed information on return shipment, including who's responsible for paying for return shipping, shipment information (return address, shipment tracking, estimated and actual delivery dates, and delivery status), and shipping costs.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
array of ShipmentTrackingType Conditionally This container is an array of shipment tracking information for one or more items.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings.active
boolean Conditionally This boolean indicates whether or not a return request is still in an active state.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .actualDeliveryDate
DateTime Conditionally This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as DELIVERED.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .actualDeliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .actualDeliveryDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .actualShipDate
DateTime Conditionally This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .actualShipDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .actualShipDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .carrierEnum
token Conditionally Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values.

Applicable values: See ShippingCarrierEnum
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .carrierId
integer Conditionally This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .carrierName
string Conditionally This field is used to show the name of the shipping carrier. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .carrierUsed
string Conditionally This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .deliveryDate
DateTime Conditionally This field has been replaced by actualDeliveryDate.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .deliveryDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .deliveryDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .deliveryStatus
string Conditionally This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded.

Applicable values are from TrackingStatusEnum:

canceled
Indicates the current shipment tracking information has been canceled.
CREATED
Indicates shipment tracking has been initiated.
DELIVERED
Indicates the item was delivered according to the shipment tracking history.
IN_TRANSIT
Indicates the item is in-transit to the recipient according to the shipment tracking history.
UNKNOWN
Indicates shipment tracking status of the item is unknown.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped to.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .destinationAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .errorCode
string Conditionally This field is only returned if the user encountered an error when trying to provide shipment tracking information.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .labelAvailableUntilDate
string Conditionally This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .labelDate
DateTime Conditionally This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .labelDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .labelDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings.labelId
string Conditionally This string value is the unique identifier of the shipping label. This field is returned if a shipping label exists for the order line item.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .labelPrintExpired
boolean Conditionally This boolean field will be returned as true if the shipping label has expired and is no longer valid to print and use for shipping.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .labelVoidExpired
boolean Conditionally This boolean field will be returned as true if the initiator of the shipping label no longer has the ability to void the shipping label.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .markAsReceived
boolean Conditionally This boolean will be returned as true if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .maxDeliveryEstimate
DateTime Conditionally This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .maxDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .maxDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .minDeliveryEstimate
DateTime Conditionally This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .minDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .minDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped from.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address.city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address.country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address.county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address.script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .originAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings.shipDate
DateTime Conditionally This field has been replaced by the actualShipDate field.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings.shipDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings.shipDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .shipmentId
string Conditionally This string value is the unique identifier of the shipment. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .shippedBy
token Conditionally Indicates the party shipping the item, such as buyer or seller.

Applicable values: See ReturnUserRoleEnum
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .shippingMethod
string Conditionally This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.

Applicable values are from ShippingMethodEnum:

SELF_MAIL
Indicates the buyer or seller handled the shipping of an item on their own, and did not use an eBay shipping label.
SHIPPING_LABEL
Indicates the buyer or seller used an eBay shipping label to ship an item.
UNKNOWN
Indicates it is unknown whether the buyer or seller used an eBay shipping label to ship an item, or handled the shipping on their own.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .allShipmentTrackings
  .trackingNumber
string Conditionally This value is the tracking number of the shipment. This field is returned if shipment tracking has been uploaded.
detail.detail
  .returnShipmentInfo.payee
token Conditionally Indicates the party whom is paying for shipping the item, such as buyer or seller.

Applicable values: See ReturnUserRoleEnum
detail.detail
  .returnShipmentInfo
  .shipmentTracking
ShipmentTrackingType Conditionally This container provides detailed information on the whereabouts of a shipped item, including tracking number, origin and destination address, shipping status, estimated and actual shipping and delivery dates, and more.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.active
boolean Conditionally This boolean indicates whether or not a return request is still in an active state.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .actualDeliveryDate
DateTime Conditionally This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as DELIVERED.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .actualDeliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .actualDeliveryDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .actualShipDate
DateTime Conditionally This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .actualShipDate.formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .actualShipDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.carrierEnum
token Conditionally Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values.

Applicable values: See ShippingCarrierEnum
detail.detail
  .returnShipmentInfo
  .shipmentTracking.carrierId
integer Conditionally This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.carrierName
string Conditionally This field is used to show the name of the shipping carrier. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.carrierUsed
string Conditionally This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.deliveryDate
DateTime Conditionally This field has been replaced by actualDeliveryDate.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.deliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.deliveryDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .deliveryStatus
string Conditionally This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded.

Applicable values are from TrackingStatusEnum:

canceled
Indicates the current shipment tracking information has been canceled.
CREATED
Indicates shipment tracking has been initiated.
DELIVERED
Indicates the item was delivered according to the shipment tracking history.
IN_TRANSIT
Indicates the item is in-transit to the recipient according to the shipment tracking history.
UNKNOWN
Indicates shipment tracking status of the item is unknown.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped to.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .destinationAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.errorCode
string Conditionally This field is only returned if the user encountered an error when trying to provide shipment tracking information.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .labelAvailableUntilDate
string Conditionally This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.labelDate
DateTime Conditionally This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.labelDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.labelDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.labelId
string Conditionally This string value is the unique identifier of the shipping label. This field is returned if a shipping label exists for the order line item.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .labelPrintExpired
boolean Conditionally This boolean field will be returned as true if the shipping label has expired and is no longer valid to print and use for shipping.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .labelVoidExpired
boolean Conditionally This boolean field will be returned as true if the initiator of the shipping label no longer has the ability to void the shipping label.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .markAsReceived
boolean Conditionally This boolean will be returned as true if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .maxDeliveryEstimate
DateTime Conditionally This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .maxDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .maxDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .minDeliveryEstimate
DateTime Conditionally This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .minDeliveryEstimate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .minDeliveryEstimate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress
ReturnAddressType Conditionally This container provides the full address where the item is being shipped from.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
Address Conditionally This container holds the address of the named party.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address.city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address.country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address.county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address.script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .originAddress.name
string Conditionally The identity of the party associated with this address.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.shipDate
DateTime Conditionally This field has been replaced by the actualShipDate field.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.shipDate
  .formattedValue
string Conditionally This field is for internal or future use.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.shipDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.shipmentId
string Conditionally This string value is the unique identifier of the shipment. This field is returned if available.
detail.detail
  .returnShipmentInfo
  .shipmentTracking.shippedBy
token Conditionally Indicates the party shipping the item, such as buyer or seller.

Applicable values: See ReturnUserRoleEnum
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .shippingMethod
string Conditionally This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.

Applicable values are from ShippingMethodEnum:

SELF_MAIL
Indicates the buyer or seller handled the shipping of an item on their own, and did not use an eBay shipping label.
SHIPPING_LABEL
Indicates the buyer or seller used an eBay shipping label to ship an item.
UNKNOWN
Indicates it is unknown whether the buyer or seller used an eBay shipping label to ship an item, or handled the shipping on their own.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shipmentTracking
  .trackingNumber
string Conditionally This value is the tracking number of the shipment. This field is returned if shipment tracking has been uploaded.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
ReturnShippingCostDetailType Conditionally This container provide the itemized list of shipping costs and how much it costs to purchase the shipping label to ship an item.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
array of ItemizedReturnShippingCostType Conditionally This container consists of the shipping cost to return ship an item. An itemizedReturnShippingCost container is required for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount
Amount Conditionally This dollar value indicates the amount for the shipping cost type shown in the returnShippingCostType field.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .amount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost
  .itemizedReturnShippingCost
  .returnShippingCostType
string Conditionally This enumerated value indicates the type of shipping cost, such as the cost of the shipping label, shipping insurance, or the signature confirmation service.

Applicable values are from ReturnShippingCostType:

INSURANCE
Indicates the shipping cost is the price of shipping insurance if it used to return ship the item back to the seller.
LABEL_COST
Indicates the shipping cost is the price of the shipping label to return the item to the seller.
OTHER
Indicates the shipping cost is not classified or is not known.
SIGNATURE_CONFIRMATION_COST
Indicates the shipping cost is the price to return ship the item to the seller using certified shipping.

Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost.totalAmount
Amount Conditionally This value is the total amount of shipping costs associated with return shipping the item. This value should equal the sum of the values in the itemizedReturnShippingCost.amount field(s).
detail.detail
  .returnShipmentInfo
  .shippingLabelCost.totalAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost.totalAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost.totalAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.detail
  .returnShipmentInfo
  .shippingLabelCost.totalAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.detail.RMANumber string Conditionally This field shows the return merchandise authorization (RMA) for the return. This field is only returned if an RMA is associated with the return request.
detail.detail.sellerAddress ReturnAddressType Conditionally This container provides the seller's default shipping address.
detail.detail.sellerAddress
  .address
Address Conditionally This container holds the address of the named party.
detail.detail.sellerAddress
  .address.addressLine1
string Conditionally The first line of the street address. The first line of the street address is always used by containers using the Address type.
detail.detail.sellerAddress
  .address.addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.detail.sellerAddress
  .address.addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

BUSINESS
Indicates the mailing address is a business address.
PO_BOX
Indicates the mailing address is a PO Box.
RESIDENCE
Indicates the mailing address is a personal residence.

Code so that your app gracefully handles any future changes to this list.
detail.detail.sellerAddress
  .address.city
string Conditionally The city of the address. This field is always used by containers using the Address type.
detail.detail.sellerAddress
  .address.country
string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
detail.detail.sellerAddress
  .address.county
string Conditionally The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.detail.sellerAddress
  .address.isTransliterated
boolean Conditionally This boolean field is returned as 'true' if language transliteration was required.
detail.detail.sellerAddress
  .address.nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.detail.sellerAddress
  .address.postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
detail.detail.sellerAddress
  .address.script
string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
detail.detail.sellerAddress
  .address.stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
detail.detail.sellerAddress
  .address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
detail.detail.sellerAddress
  .address.worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type.

Applicable values are from WorldRegionEnum:See worldRegion.
Code so that your app gracefully handles any future changes to this list.
detail.detail.sellerAddress
  .name
string Conditionally The identity of the party associated with this address.
detail.detail.sellerLoginName string Conditionally This string value is the eBay user name of the seller.
detail.summary ReturnSummaryType Conditionally This container consists of summarized information on the order line item that is associated with the return request. This container is not returned if the fieldgroups query parameter is omitted, or if it is used and its value is set to FULL or NONE.'
detail.summary
  .buyerAvailableOptions
array of AvailableOptionType Conditionally This container consists of the next option(s) that are available to the buyer to move the return request to the next stage. A buyerAvailableOptions container will be returned for each option that is available to the buyer.
detail.summary
  .buyerAvailableOptions
  .actionType
token Always This token value informs the buyer or seller what the next action is to move the return request to the next stage. Note that not all values in the ActivityOptionEnum type are applicable and possibly returned in this field.

Applicable values: See ActivityOptionEnum
detail.summary
  .buyerAvailableOptions
  .actionURL
string Conditionally This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action.
detail.summary.buyerLoginName string Conditionally This string value is the eBay user name of the buyer.
detail.summary
  .buyerResponseDue
ReturnResponseDueType Conditionally This container indicates when the next buyer response on the return is due.
detail.summary
  .buyerResponseDue.activityDue
token Conditionally This value informs the buyer or seller what the next action is to move the return request to the next stage.

Applicable values: See ActivityOptionEnum
detail.summary
  .buyerResponseDue
  .respondByDate
DateTime Conditionally This timestamp indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.
detail.summary
  .buyerResponseDue
  .respondByDate.formattedValue
string Conditionally This field is for internal or future use.
detail.summary
  .buyerResponseDue
  .respondByDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary
  .buyerTotalRefund
TotalRefundAmountType Conditionally This container shows the estimated and actual refund to the buyer. A refund to the buyer will generally be coming from seller.
detail.summary
  .buyerTotalRefund
  .actualRefundAmount
Amount Conditionally This container shows the actual refund amount that was issue to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container). This container is only returned if a refund has been issued.
detail.summary
  .buyerTotalRefund
  .actualRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .buyerTotalRefund
  .actualRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.summary
  .buyerTotalRefund
  .actualRefundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .buyerTotalRefund
  .actualRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.summary
  .buyerTotalRefund
  .estimatedRefundAmount
Amount Always This container shows the estimated refund amount that may be issued to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container).
detail.summary
  .buyerTotalRefund
  .estimatedRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .buyerTotalRefund
  .estimatedRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.summary
  .buyerTotalRefund
  .estimatedRefundAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .buyerTotalRefund
  .estimatedRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.summary.creationInfo ReturnCreationInfoType Always This container provides details about the buyer's return request, including the order line item (and quantity) that is being returned, the reason for the return, and the buyer's preference to either get money back for item or to get a replacement item from the seller.
detail.summary.creationInfo
  .comments
Text Conditionally If provided by the buyer at return creation time, this container provides more information to the seller about why a return is being requested. This container is only returned if the buyer made a comment at the time of creating the return request or draft.
detail.summary.creationInfo
  .comments.content
string Conditionally This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
detail.summary.creationInfo
  .comments.language
string Conditionally This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

Applicable values are from LanguageEnum:See language.
Code so that your app gracefully handles any future changes to this list.
detail.summary.creationInfo
  .comments
  .translatedFromContent
string Conditionally If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
detail.summary.creationInfo
  .comments
  .translatedFromLanguage
string Conditionally If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

Applicable values are from LanguageEnum:See translatedFromLanguage.
Code so that your app gracefully handles any future changes to this list.
detail.summary.creationInfo
  .creationDate
DateTime Always This timestamp indicates the date/time when the return request was created.
detail.summary.creationInfo
  .creationDate.formattedValue
string Conditionally This field is for internal or future use.
detail.summary.creationInfo
  .creationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary.creationInfo
  .item
ReturnItemType Always This container provides information on the return item, including listing ID, listing title, order line item ID, and the quantity of the line item that is being returned.
detail.summary.creationInfo
  .item.itemId
string Conditionally This is the unique identifier of the listing. The itemId value and the transactionId values identify the order line item. This field is always returned with the item container.
detail.summary.creationInfo
  .item.returnQuantity
integer Conditionally This integer value indicates the quantity of the line item being returned. This number is generally 1, unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing. This field is always returned with the item container.
detail.summary.creationInfo
  .item.transactionId
string Conditionally This is the unique identifier of the transaction. The itemId value and the transactionId values identify the order line item. This field is always returned with the item container.
detail.summary.creationInfo
  .reason
string Always This enumerated value indicates the buyer's reason for creating a return request or draft.

Applicable values are from ReturnReasonEnum:See reason.
Code so that your app gracefully handles any future changes to this list.
detail.summary.creationInfo
  .type
string Always This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item).

Applicable values are from ReturnTypeEnum:

CANCEL
This value is passed into the type field of the request when the buyer wants to cancel a return request (or draft).
MONEY_BACK
This value is passed into the type field of the request when the buyer is creating a return request (or draft), and wants a full refund after returning the item.
REPLACEMENT
This value is passed into the type field of the request when the buyer is creating a return request (or draft), but wants a replacement item instead of a refund.
UNKNOWN
This is the default value if the return type is not known.

Code so that your app gracefully handles any future changes to this list.
detail.summary.currentType string Conditionally This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item).

Applicable values are from ReturnTypeEnum:

CANCEL
This value is passed into the type field of the request when the buyer wants to cancel a return request (or draft).
MONEY_BACK
This value is passed into the type field of the request when the buyer is creating a return request (or draft), and wants a full refund after returning the item.
REPLACEMENT
This value is passed into the type field of the request when the buyer is creating a return request (or draft), but wants a replacement item instead of a refund.
UNKNOWN
This is the default value if the return type is not known.

Code so that your app gracefully handles any future changes to this list.
detail.summary
  .dispositionRuleTriggered
array of string Conditionally This enumerated value indicates the type of disposition rule triggered by the return request. More than one dispositionRuleTriggered field may be returned.

Applicable values are from DispositionRuleTemplateTypeEnum:

AUTO_REFUND_NO_SHIPBACK
Indicates the auto-refund with no return shipping disposition rule template will be used.
AUTO_ROUTE
Indicates the auto-route disposition rule template will be used.
OTHER
Indicates another disposition rule template will be used.
SEND_REPLACEMENT_NO_SHIPBACK
Indicates the replacement item with no return shipping disposition rule template will be used.

Code so that your app gracefully handles any future changes to this list.
detail.summary.escalationInfo EscalationInfoType Conditionally This container provides information on whether or not the buyer or seller is eligible to escalate a return request to a case, and if a return request was escalated, a caseId can be found in this container.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
EscalationEligibilityInfo Always This container indicates if the buyer is eligible to escalate the return request into a return case. If the buyer is eligible to escalate the return request into a return case, the time window during which this buyer must perform this action is returned under this container.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .eligible
boolean Always This boolean value indicates whether or not the buyer or seller is eligible to escalate the case. If the value is 'true', the time window in which the buyer or seller can escalate the case is found in the startTime and endTime fields.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .endTime
DateTime Conditionally This timestamp provides the deadline in which the buyer or seller may escalate the case. As soon as this time expires, the buyer or seller may no longer escalate the case. This field will not be returned if the value of the eligible field is 'false'.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .endTime.formattedValue
string Conditionally This field is for internal or future use.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .endTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .startTime
DateTime Conditionally This timestamp provides the earliest date in which the buyer or seller may escalate the case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the case. This field will not be returned if the value of the eligible field is 'false'.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .startTime.formattedValue
string Conditionally This field is for internal or future use.
detail.summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .startTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary.escalationInfo
  .caseId
string Conditionally The unique identifier of an eBay case. This field will only be returned if the return request was successfully escalated to a return case.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
EscalationEligibilityInfo Always This container indicates if the seller is eligible to escalate the return request into a return case. If the seller is eligible to escalate the return request into a return case, the time window during which this seller must perform this action is returned under this container.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .eligible
boolean Always This boolean value indicates whether or not the buyer or seller is eligible to escalate the case. If the value is 'true', the time window in which the buyer or seller can escalate the case is found in the startTime and endTime fields.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .endTime
DateTime Conditionally This timestamp provides the deadline in which the buyer or seller may escalate the case. As soon as this time expires, the buyer or seller may no longer escalate the case. This field will not be returned if the value of the eligible field is 'false'.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .endTime.formattedValue
string Conditionally This field is for internal or future use.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .endTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .startTime
DateTime Conditionally This timestamp provides the earliest date in which the buyer or seller may escalate the case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the case. This field will not be returned if the value of the eligible field is 'false'.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .startTime.formattedValue
string Conditionally This field is for internal or future use.
detail.summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .startTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary.returnId string Conditionally The unique identifier of the return request.
detail.summary.returnPolicy ReturnPolicyType Conditionally This container indicates whether or not the seller is required to provide an RMA (return merchandise authorization) number to the buyer. The seller can use the POST /post-order/v2/return/{returnId}/decide call to provide the buyer with the RMA number.
detail.summary.returnPolicy
  .RMARequired
boolean Conditionally This boolean field is returned as true if the seller is expected to provide a return merchandise authorization (RMA) number to the buyer before the buyer return ships the order line item. The seller can use the POST /post-order/v2/return/{returnId}/decide call to provide the buyer with the RMA number for the item.
detail.summary
  .sellerAvailableOptions
array of AvailableOptionType Conditionally This container consists of the next option(s) that are available to the seller to move the return request to the next stage. A sellerAvailableOptions container will be returned for each option that is available to the seller.
detail.summary
  .sellerAvailableOptions
  .actionType
token Always This token value informs the buyer or seller what the next action is to move the return request to the next stage. Note that not all values in the ActivityOptionEnum type are applicable and possibly returned in this field.

Applicable values: See ActivityOptionEnum
detail.summary
  .sellerAvailableOptions
  .actionURL
string Conditionally This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action.
detail.summary.sellerLoginName string Conditionally This string value is the eBay user name of the seller.
detail.summary
  .sellerResponseDue
ReturnResponseDueType Conditionally This container indicates when the next seller response on the return is due.
detail.summary
  .sellerResponseDue.activityDue
token Conditionally This value informs the buyer or seller what the next action is to move the return request to the next stage.

Applicable values: See ActivityOptionEnum
detail.summary
  .sellerResponseDue
  .respondByDate
DateTime Conditionally This timestamp indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.
detail.summary
  .sellerResponseDue
  .respondByDate.formattedValue
string Conditionally This field is for internal or future use.
detail.summary
  .sellerResponseDue
  .respondByDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
detail.summary
  .sellerTotalRefund
TotalRefundAmountType Conditionally This container shows the estimated and actual refund to the seller. A refund to the seller will generally be coming from eBay.
detail.summary
  .sellerTotalRefund
  .actualRefundAmount
Amount Conditionally This container shows the actual refund amount that was issue to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container). This container is only returned if a refund has been issued.
detail.summary
  .sellerTotalRefund
  .actualRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .sellerTotalRefund
  .actualRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.summary
  .sellerTotalRefund
  .actualRefundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .sellerTotalRefund
  .actualRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.summary
  .sellerTotalRefund
  .estimatedRefundAmount
Amount Always This container shows the estimated refund amount that may be issued to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container).
detail.summary
  .sellerTotalRefund
  .estimatedRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .sellerTotalRefund
  .estimatedRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
detail.summary
  .sellerTotalRefund
  .estimatedRefundAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
detail.summary
  .sellerTotalRefund
  .estimatedRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
detail.summary.state token Conditionally Indicates the current state of the return.

Applicable values: See ReturnStateEnum
detail.summary.status token Conditionally Indicates the current status of the return request.

Applicable values: See ReturnStatusEnum
eligibilityResult ReturnEligibilityPerItemType Always This container consists of information on the return item and the results for each eligibility check type that was run against the order line item.
eligibilityResult
  .eligibilityResultsPerCheckType
array of ReturnEligibilityItemPerCheckTypeResult Always This container contains the results for each eligibility check type, including whether or not the line item is eligible to be returned, and any errors that may have occurred with the check.
eligibilityResult
  .eligibilityResultsPerCheckType
  .checkType
string Always This enumerated value indicates the type of eligibility check that was run against the order line item. For the POST /post-order/v2/return/check_eligibility call, multiple eligibility checks can be run against the order line item, but the POST /post-order/v2/return call only uses the RETURN_CREATION check.

Applicable values are from EligibilityCheckTypeEnum:

ITEM_SELECTION
Checks that the item is paid for and happens before the return reason is selected.
PRE_TRANSACTION
Check that happens before the item is purchased.
REPLACEMENT_CREATION
Check that happens during the replacement creation process.
REPLACEMENT_ITEM_SELECTION
Checks that the item is paid for and is eligible for replacement. This happens before the return reason is selected.
RETURN_CREATION
Check that happens during the return creation process.

Code so that your app gracefully handles any future changes to this list.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
EligibilityResultType Always This container includes the results of the eligibility check, including any errors that may have occurred with the eligibility check, as well as detailed information on the return request.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo.caseId
string Conditionally This value is the unique identifier of an eBay case associated with the return request. This field is only returned if the return request was escalated into an eBay case.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibilityErrorDetail
array of ReturnEligibilityErrorDetailType Conditionally This container consists of an error that occurred with the return eligibility check. This container is only returned if one or more return eligibility check errors occurred.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibilityErrorDetail
  .eligibilityError
EligibilityErrorType Conditionally This container holds an array of one or more errors that occurred with an item return eligibility check, including the error code, the description of the error, and the enumeration value associated with the error. This container is only returned if one or more errors occur with an item eligibility check.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibilityErrorDetail
  .eligibilityError.code
string Conditionally Unique identifier of the enumeration value.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibilityErrorDetail
  .eligibilityError.content
string Conditionally The actual content of the eligibility error.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibilityErrorDetail
  .eligibilityError.description
string Conditionally A description of the enumeration value.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibilityStatus
string Always This enumerated value indicates the success or failure of an return-related eligibility check. See StatusType for the description of the supported values.

Applicable values are from StatusType:

FAILED
Indicates the return eligibility check failed.
SELLER_APPROVAL
Indicates the return eligibility check requires seller approval.
SUCCESS
Indicates the return eligibility check was successful.
UNKNOWN
Indicates the status of the return eligibility check is unknown.

Code so that your app gracefully handles any future changes to this list.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibleStartDate
DateTime Conditionally This timestamp indicates when the buyer is eligible to create a return request for an item. This field is not returned if the buyer is not eligible to return the item.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibleStartDate
  .formattedValue
string Conditionally This field is for internal or future use.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .eligibleStartDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .returnCreationDate
DateTime Conditionally This timestamp indicates the date/time when the return request was created. This field is only returned if return request was successfully created.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .returnCreationDate
  .formattedValue
string Conditionally This field is for internal or future use.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .returnCreationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .returnDeadline
DateTime Always This timestamp indicates the deadline in which the buyer must file a return request.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .returnDeadline.formattedValue
string Conditionally This field is for internal or future use.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo
  .returnDeadline.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
eligibilityResult
  .eligibilityResultsPerCheckType
  .eligibilityInfo.returnId
string Conditionally The unique identifier of the newly created return request. This field is only returned if return request was successfully created.
eligibilityResult.returnItem ReturnEligibilityItemType Always This container consists of summary information on the line item being returned, including the listing ID, the line item ID, the return reason, and the quantity purchased.
eligibilityResult.returnItem
  .itemId
string Always This is the unique identifier of the listing.
eligibilityResult.returnItem
  .reason
string Always This enumerated value lists indicates the buyer's reason for returning the item.

Applicable values are from ReturnReasonEnum:See reason.
Code so that your app gracefully handles any future changes to this list.
eligibilityResult.returnItem
  .returnQuantity
integer Always This integer value indicates the quantity of the line item being returned. This number is generally '1', unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing.
eligibilityResult.returnItem
  .transactionId
string Always This is the unique identifier of the order line item.
returnId string Conditionally The unique identifier of the newly created return request. This field is only returned if the return request was successfully created.
summary ReturnSummaryType Conditionally This container consists of summarized information on the return item. This container will not be returned if the fieldGroups query parameter is used and its value is set to FULL or NONE.
summary.buyerAvailableOptions array of AvailableOptionType Conditionally This container consists of the next option(s) that are available to the buyer to move the return request to the next stage. A buyerAvailableOptions container will be returned for each option that is available to the buyer.
summary.buyerAvailableOptions
  .actionType
token Always This token value informs the buyer or seller what the next action is to move the return request to the next stage. Note that not all values in the ActivityOptionEnum type are applicable and possibly returned in this field.

Applicable values: See ActivityOptionEnum
summary.buyerAvailableOptions
  .actionURL
string Conditionally This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action.
summary.buyerLoginName string Conditionally This string value is the eBay user name of the buyer.
summary.buyerResponseDue ReturnResponseDueType Conditionally This container indicates when the next buyer response on the return is due.
summary.buyerResponseDue
  .activityDue
token Conditionally This value informs the buyer or seller what the next action is to move the return request to the next stage.

Applicable values: See ActivityOptionEnum
summary.buyerResponseDue
  .respondByDate
DateTime Conditionally This timestamp indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.
summary.buyerResponseDue
  .respondByDate.formattedValue
string Conditionally This field is for internal or future use.
summary.buyerResponseDue
  .respondByDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.buyerTotalRefund TotalRefundAmountType Conditionally This container shows the estimated and actual refund to the buyer. A refund to the buyer will generally be coming from seller.
summary.buyerTotalRefund
  .actualRefundAmount
Amount Conditionally This container shows the actual refund amount that was issue to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container). This container is only returned if a refund has been issued.
summary.buyerTotalRefund
  .actualRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund
  .actualRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
summary.buyerTotalRefund
  .actualRefundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund
  .actualRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
summary.buyerTotalRefund
  .estimatedRefundAmount
Amount Always This container shows the estimated refund amount that may be issued to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container).
summary.buyerTotalRefund
  .estimatedRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund
  .estimatedRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
summary.buyerTotalRefund
  .estimatedRefundAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund
  .estimatedRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
summary.creationInfo ReturnCreationInfoType Always This container provides details about the buyer's return request, including the order line item (and quantity) that is being returned, the reason for the return, and the buyer's preference to either get money back for item or to get a replacement item from the seller.
summary.creationInfo.comments Text Conditionally If provided by the buyer at return creation time, this container provides more information to the seller about why a return is being requested. This container is only returned if the buyer made a comment at the time of creating the return request or draft.
summary.creationInfo.comments
  .content
string Conditionally This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
summary.creationInfo.comments
  .language
string Conditionally This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

Applicable values are from LanguageEnum:See language.
Code so that your app gracefully handles any future changes to this list.
summary.creationInfo.comments
  .translatedFromContent
string Conditionally If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
summary.creationInfo.comments
  .translatedFromLanguage
string Conditionally If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

Applicable values are from LanguageEnum:See translatedFromLanguage.
Code so that your app gracefully handles any future changes to this list.
summary.creationInfo
  .creationDate
DateTime Always This timestamp indicates the date/time when the return request was created.
summary.creationInfo
  .creationDate.formattedValue
string Conditionally This field is for internal or future use.
summary.creationInfo
  .creationDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.creationInfo.item ReturnItemType Always This container provides information on the return item, including listing ID, listing title, order line item ID, and the quantity of the line item that is being returned.
summary.creationInfo.item
  .itemId
string Conditionally This is the unique identifier of the listing. The itemId value and the transactionId values identify the order line item. This field is always returned with the item container.
summary.creationInfo.item
  .returnQuantity
integer Conditionally This integer value indicates the quantity of the line item being returned. This number is generally 1, unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing. This field is always returned with the item container.
summary.creationInfo.item
  .transactionId
string Conditionally This is the unique identifier of the transaction. The itemId value and the transactionId values identify the order line item. This field is always returned with the item container.
summary.creationInfo.reason string Always This enumerated value indicates the buyer's reason for creating a return request or draft.

Applicable values are from ReturnReasonEnum:See reason.
Code so that your app gracefully handles any future changes to this list.
summary.creationInfo.type string Always This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item).

Applicable values are from ReturnTypeEnum:

CANCEL
This value is passed into the type field of the request when the buyer wants to cancel a return request (or draft).
MONEY_BACK
This value is passed into the type field of the request when the buyer is creating a return request (or draft), and wants a full refund after returning the item.
REPLACEMENT
This value is passed into the type field of the request when the buyer is creating a return request (or draft), but wants a replacement item instead of a refund.
UNKNOWN
This is the default value if the return type is not known.

Code so that your app gracefully handles any future changes to this list.
summary.currentType string Conditionally This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item).

Applicable values are from ReturnTypeEnum:

CANCEL
This value is passed into the type field of the request when the buyer wants to cancel a return request (or draft).
MONEY_BACK
This value is passed into the type field of the request when the buyer is creating a return request (or draft), and wants a full refund after returning the item.
REPLACEMENT
This value is passed into the type field of the request when the buyer is creating a return request (or draft), but wants a replacement item instead of a refund.
UNKNOWN
This is the default value if the return type is not known.

Code so that your app gracefully handles any future changes to this list.
summary
  .dispositionRuleTriggered
array of string Conditionally This enumerated value indicates the type of disposition rule triggered by the return request. More than one dispositionRuleTriggered field may be returned.

Applicable values are from DispositionRuleTemplateTypeEnum:

AUTO_REFUND_NO_SHIPBACK
Indicates the auto-refund with no return shipping disposition rule template will be used.
AUTO_ROUTE
Indicates the auto-route disposition rule template will be used.
OTHER
Indicates another disposition rule template will be used.
SEND_REPLACEMENT_NO_SHIPBACK
Indicates the replacement item with no return shipping disposition rule template will be used.

Code so that your app gracefully handles any future changes to this list.
summary.escalationInfo EscalationInfoType Conditionally This container provides information on whether or not the buyer or seller is eligible to escalate a return request to a case, and if a return request was escalated, a caseId can be found in this container.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
EscalationEligibilityInfo Always This container indicates if the buyer is eligible to escalate the return request into a return case. If the buyer is eligible to escalate the return request into a return case, the time window during which this buyer must perform this action is returned under this container.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .eligible
boolean Always This boolean value indicates whether or not the buyer or seller is eligible to escalate the case. If the value is 'true', the time window in which the buyer or seller can escalate the case is found in the startTime and endTime fields.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .endTime
DateTime Conditionally This timestamp provides the deadline in which the buyer or seller may escalate the case. As soon as this time expires, the buyer or seller may no longer escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .endTime.formattedValue
string Conditionally This field is for internal or future use.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .endTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .startTime
DateTime Conditionally This timestamp provides the earliest date in which the buyer or seller may escalate the case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .startTime.formattedValue
string Conditionally This field is for internal or future use.
summary.escalationInfo
  .buyerEscalationEligibilityInfo
  .startTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.escalationInfo.caseId string Conditionally The unique identifier of an eBay case. This field will only be returned if the return request was successfully escalated to a return case.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
EscalationEligibilityInfo Always This container indicates if the seller is eligible to escalate the return request into a return case. If the seller is eligible to escalate the return request into a return case, the time window during which this seller must perform this action is returned under this container.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .eligible
boolean Always This boolean value indicates whether or not the buyer or seller is eligible to escalate the case. If the value is 'true', the time window in which the buyer or seller can escalate the case is found in the startTime and endTime fields.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .endTime
DateTime Conditionally This timestamp provides the deadline in which the buyer or seller may escalate the case. As soon as this time expires, the buyer or seller may no longer escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .endTime.formattedValue
string Conditionally This field is for internal or future use.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .endTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .startTime
DateTime Conditionally This timestamp provides the earliest date in which the buyer or seller may escalate the case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .startTime.formattedValue
string Conditionally This field is for internal or future use.
summary.escalationInfo
  .sellerEscalationEligibilityInfo
  .startTime.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.returnId string Conditionally The unique identifier of the return request.
summary.returnPolicy ReturnPolicyType Conditionally This container indicates whether or not the seller is required to provide an RMA (return merchandise authorization) number to the buyer. The seller can use the POST /post-order/v2/return/{returnId}/decide call to provide the buyer with the RMA number.
summary.returnPolicy
  .RMARequired
boolean Conditionally This boolean field is returned as true if the seller is expected to provide a return merchandise authorization (RMA) number to the buyer before the buyer return ships the order line item. The seller can use the POST /post-order/v2/return/{returnId}/decide call to provide the buyer with the RMA number for the item.
summary.sellerAvailableOptions array of AvailableOptionType Conditionally This container consists of the next option(s) that are available to the seller to move the return request to the next stage. A sellerAvailableOptions container will be returned for each option that is available to the seller.
summary.sellerAvailableOptions
  .actionType
token Always This token value informs the buyer or seller what the next action is to move the return request to the next stage. Note that not all values in the ActivityOptionEnum type are applicable and possibly returned in this field.

Applicable values: See ActivityOptionEnum
summary.sellerAvailableOptions
  .actionURL
string Conditionally This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action.
summary.sellerLoginName string Conditionally This string value is the eBay user name of the seller.
summary.sellerResponseDue ReturnResponseDueType Conditionally This container indicates when the next seller response on the return is due.
summary.sellerResponseDue
  .activityDue
token Conditionally This value informs the buyer or seller what the next action is to move the return request to the next stage.

Applicable values: See ActivityOptionEnum
summary.sellerResponseDue
  .respondByDate
DateTime Conditionally This timestamp indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.
summary.sellerResponseDue
  .respondByDate.formattedValue
string Conditionally This field is for internal or future use.
summary.sellerResponseDue
  .respondByDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
summary.sellerTotalRefund TotalRefundAmountType Conditionally This container shows the estimated and actual refund to the seller. A refund to the seller will generally be coming from eBay.
summary.sellerTotalRefund
  .actualRefundAmount
Amount Conditionally This container shows the actual refund amount that was issue to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container). This container is only returned if a refund has been issued.
summary.sellerTotalRefund
  .actualRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund
  .actualRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
summary.sellerTotalRefund
  .actualRefundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund
  .actualRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
summary.sellerTotalRefund
  .estimatedRefundAmount
Amount Always This container shows the estimated refund amount that may be issued to the buyer (if returned under the buyerTotalRefund container) or seller (if returned under the sellerTotalRefund container).
summary.sellerTotalRefund
  .estimatedRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund
  .estimatedRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
summary.sellerTotalRefund
  .estimatedRefundAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund
  .estimatedRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
summary.state token Conditionally Indicates the current state of the return.

Applicable values: See ReturnStateEnum
summary.status token Conditionally Indicates the current status of the return request.

Applicable values: See ReturnStatusEnum



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Create a return

This operation creates a return request.

Description

This buyer-facing call creates a return request. The seller must approve the request before it can be processed.

Input

Use the itemId and transactionId fields to specify the order line item to be returned. Specify a reason as well as the action (the returnRequest.type) to inform the seller of the details of the return. If you have created a return draft, supply the draftId to submit the draft as a return request.

URL format. See also the non-wrapped version of this URL.

POST https://api.ebay.com/post-order/v2/return?
   fieldgroups=NONE { "returnRequest": { "itemId": "330005959274", "transactionId": "8905715014", "returnQuantity": "1", "reason": "NO_LONGER_NEED_ITEM", "type": "MONEY_BACK", "carrier": "USPS", "comments": { "content": "I accidentally purchased the same product twice" } } }

Output

The fieldgroups value is set to NONE, so only the returnId value is returned. that you use to reference the return in other calls. The call response will be much larger if the fieldgroups value is set to SUMMARY or FULL.

JSON format.
{
  "returnId": "5000116809"
}



Change History

Change Date Description
1.0
2015-06-30
  • Call (added): New call.