Create Return Request
POST /post-order/v2/return
This method is used to create a return request on behalf of the buyer. If you are converting a return request 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 request draft into a return request, you must include values for the itemId, transactionId, reason, returnQuantity, and type fields.
This method is not supported in the Sandbox environment.
| Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/return? fieldgroups=GetReturnFieldGroupEnum
URI parameters
| Parameter | Type | Required? | Meaning |
|---|---|---|---|
| fieldgroups | string | Optional |
The fieldgroups query parameter is used to control the detail level that is returned in the response. One of the values defined in the GetReturnFieldGroupEnum type definition must be used here. If this query parameter is not included in the request, its value defaults to NONE, which means that only the returnId value for the newly-created return request will be in the response.
Applicable values are from GetReturnFieldGroupEnum. |
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": string,
"comments":
{ /* Text */
"content": string,
"language": string,
"translatedFromContent": string,
"translatedFromLanguage": string
},
"itemId": string,
"reason": string,
"requestType": string,
"returnQuantity": integer,
"transactionId": string,
"type": string
}
}
Request field descriptions
| Input Container/Field | Type | Occurrence | Meaning |
|---|---|---|---|
| draftId | string | Conditional | The unique eBay-assigned ID of a return request draft. This field is only applicable (and required) if the buyer is converting a return request draft into an actual return request with the POST /post-order/v2/return method. |
| 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 or the reason for the return. |
| returnRequest.carrier | string | Optional |
This enumeration value indicates the shipping carrier that will be used to ship the return item. The supported enumeration values representing shipping carriers are defined in the ShippingCarrierEnum type definition. Applicable values: See ShippingCarrierEnum |
| returnRequest.comments | Text | Optional | This container is used if the buyer wants to add a note or explanation about why the return request was created. |
| 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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
|
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
| returnRequest.itemId | string | Required | The unique identifier of the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order. |
| returnRequest.reason | string | Optional |
This enumerated value indicates the buyer's reason for creating a return request or draft. The supported enumeration values representing valid return reasons are defined in the ReturnReasonEnum type definition. Applicable values: See ReturnReasonEnum |
| returnRequest.requestType | string | Required |
This enumeration value indicates if the return request is an actual return request or a return draft.
Applicable values are from 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 for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order. |
| returnRequest.type | string | Optional |
This enumeration value indicates the buyer's desired outcome. Note: Currently, MONEY_BACK
Applicable values are from ReturnTypeEnum: Note: This value is deprecated. Note: This value is not currently supported. Note: This value is deprecated. |
| Input Samples Change History |
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": string,
"returnCloseDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"returnCloseReason": string
},
"files": [
{ /* ReturnFileType */
"creationDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"fileData": string,
"fileFormat": string,
"fileId": string,
"fileName": string,
"filePurpose": string,
"fileStatus": string,
"resizedFileData": string,
"secureUrl": string,
"submitter": string
}
/* 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 */
"ebayPlusTxn": boolean,
"itemId": string,
"itemOnHold": boolean,
"itemPicUrl": string,
"itemPrice":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"itemTitle": string,
"listingSiteId": integer,
"relistedItemId": string,
"relistStatus": string,
"returnQuantity": integer,
"transactionDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"transactionId": string
},
"marketplaceId": string,
"moneyMovementInfo": [
{ /* ret:MoneyMovementDetailType */
"actualAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"creationDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"externalPaymentId": string,
"moneyMovementType": string,
"paymentProvider": string,
"requestedAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"status": string
}
/* More ret:MoneyMovementDetailType nodes here */
],
"payoutRecoupInfo":
{ /* ReturnPayoutRecoupInfoType */
"amountToRecoup":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"payoutId": integer
},
"refundInfo":
{ /* RefundInfoType */
"actualRefundDetail":
{ /* ActualRefundDetailType */
"actualRefund":
{ /* RefundDetailType */
"donationAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"feeCreditAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"itemizedRefundDetail": [
{ /* ItemizedRefundDetailType */
"refundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"refundFeeType": string,
"restockingFeePercentage": string
}
/* More ItemizedRefundDetailType nodes here */
],
"totalAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
}
},
"fundings": [
{ /* RefundFundingType */
"amount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"date":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"fundingSource":
{ /* FundingSourceType */
"brand": string,
"memo": string,
"type": string
},
"fundingStatus": string
}
/* More RefundFundingType nodes here */
],
"netChargeAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"outstandingAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"refundInitiationType": string,
"refundIssuedDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"refundStatus": string
},
"estimatedRefundDetail":
{ /* EstimatedRefundDetailType */
"itemizedRefundDetails": [
{ /* EstimatedRefundType */
"estimatedAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"maxAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"minAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"purchasePriceDeductedPercentageList": [
integer
/* More integer nodes here */
],
"refundFeeType": string,
"restockingFeePercentage": string
}
/* More EstimatedRefundType nodes here */
],
"optionalRefundLineItems": [
{ /* EstimatedRefundType */
"estimatedAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"maxAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"minAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"purchasePriceDeductedPercentageList": [
integer
/* More integer nodes here */
],
"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": string,
"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": string,
"shippingMethod": string,
"trackingNumber": string
}
/* More ShipmentTrackingType nodes here */
],
"payee": string,
"shipmentTracking":
{ /* ShipmentTrackingType */
"active": boolean,
"actualDeliveryDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"actualShipDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"carrierEnum": string,
"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": string,
"shippingMethod": string,
"trackingNumber": string
},
"shippingLabelCost":
{ /* ReturnShippingCostDetailType */
"itemizedReturnShippingCost": [
{ /* ItemizedReturnShippingCostType */
"amount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"returnShippingCostType": string
}
/* More ItemizedReturnShippingCostType nodes here */
],
"totalAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
}
}
},
"responseHistory": [
{ /* ReturnResponseHistoryType */
"activity": string,
"attributes":
{ /* ResponseHistoryAttributesType */
"escalateReason": string,
"keepOriginalItem": boolean,
"moneyMovementRef":
{ /* MoneyMovementRef */
"idref": string
},
"partialRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"refundDeductionType":
{ /* RefundDeductionType */
"refundDeductionAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"refundDeductionPercentage": integer
},
"rlspType": string,
"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,
"updatedTrackingNumber": string
},
"author": string,
"creationDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"fromState": string,
"notes": string,
"toState": string
}
/* More ReturnResponseHistoryType nodes here */
],
"returnContentOnHold": boolean,
"returnShipmentInfo":
{ /* ShipmentType */
"allShipmentTrackings": [
{ /* ShipmentTrackingType */
"active": boolean,
"actualDeliveryDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"actualShipDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"carrierEnum": string,
"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": string,
"shippingMethod": string,
"trackingNumber": string
}
/* More ShipmentTrackingType nodes here */
],
"payee": string,
"shipmentTracking":
{ /* ShipmentTrackingType */
"active": boolean,
"actualDeliveryDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"actualShipDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
},
"carrierEnum": string,
"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": string,
"shippingMethod": string,
"trackingNumber": string
},
"shippingLabelCost":
{ /* ReturnShippingCostDetailType */
"itemizedReturnShippingCost": [
{ /* ItemizedReturnShippingCostType */
"amount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"returnShippingCostType": string
}
/* More ItemizedReturnShippingCostType nodes here */
],
"totalAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": 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": string,
"actionURL": string
}
/* More AvailableOptionType nodes here */
],
"buyerLoginName": string,
"buyerResponseDue":
{ /* ReturnResponseDueType */
"activityDue": string,
"respondByDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
}
},
"buyerTotalRefund":
{ /* TotalRefundAmountType */
"actualRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"estimatedRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": 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,
"reasonType": string,
"type": string
},
"currentType": string,
"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
}
}
},
"orderId": string,
"returnId": string,
"returnPolicy":
{ /* ReturnPolicyType */
"rmaRequired": boolean
},
"sellerAvailableOptions": [
{ /* AvailableOptionType */
"actionType": string,
"actionURL": string
}
/* More AvailableOptionType nodes here */
],
"sellerLoginName": string,
"sellerResponseDue":
{ /* ReturnResponseDueType */
"activityDue": string,
"respondByDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
}
},
"sellerTotalRefund":
{ /* TotalRefundAmountType */
"actualRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"estimatedRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
}
},
"state": string,
"status": string,
"timeoutDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
}
}
},
"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": string,
"actionURL": string
}
/* More AvailableOptionType nodes here */
],
"buyerLoginName": string,
"buyerResponseDue":
{ /* ReturnResponseDueType */
"activityDue": string,
"respondByDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
}
},
"buyerTotalRefund":
{ /* TotalRefundAmountType */
"actualRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"estimatedRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": 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,
"reasonType": string,
"type": string
},
"currentType": string,
"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
}
}
},
"orderId": string,
"returnId": string,
"returnPolicy":
{ /* ReturnPolicyType */
"rmaRequired": boolean
},
"sellerAvailableOptions": [
{ /* AvailableOptionType */
"actionType": string,
"actionURL": string
}
/* More AvailableOptionType nodes here */
],
"sellerLoginName": string,
"sellerResponseDue":
{ /* ReturnResponseDueType */
"activityDue": string,
"respondByDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
}
},
"sellerTotalRefund":
{ /* TotalRefundAmountType */
"actualRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
},
"estimatedRefundAmount":
{ /* Amount */
"convertedFromCurrency": string,
"convertedFromValue": number,
"currency": string,
"exchangeRate": string,
"value": number
}
},
"state": string,
"status": string,
"timeoutDate":
{ /* DateTime */
"formattedValue": string,
"value": datetime
}
}
}
Response field descriptions
| Output Container/Field | Type | Occurrence | Meaning |
|---|---|---|---|
| detail | GetDetailResponse | Conditionally |
This container consists of detailed information on the return request. 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 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 where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
detail.detail.buyerAddress .address.county |
string | Conditionally | The county of the address. This field is not always used, but it should be provided 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail.buyerAddress .address.worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail.buyerAddress .name |
string | Conditionally | The name/business name associated with the 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. This container is only returned for return requests that have been closed. |
|
detail.detail.closeInfo .buyerCloseComment |
string | Conditionally | This string field will be returned if the buyer made a comment 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 |
string | Conditionally |
This enumeration value indicates the reason that the buyer is closing the return request. A buyer would typically close a return request after they receive a refund or if they initiated the return request by mistake. This field is only returned if the return request was closed and the buyer was the one (and not eBay) that initiated the closure of the return request.
Applicable values are from BuyerCloseReturnReasonEnum:See buyerCloseReason. Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.closeInfo .returnCloseDate |
DateTime | Conditionally | The timestamp in this container indicates when the return request was closed. This field is only returned if the return request was closed. |
|
detail.detail.closeInfo .returnCloseDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.closeInfo .returnCloseDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail.closeInfo .returnCloseReason |
string | Conditionally |
This enumeration value indicates the reason why the return request was closed. The enumeration value returned here will be the reason why eBay closed the return request, and not why the buyer wanted to close the return request. This field is only returned if the return request was closed.
Applicable values are from CloseReturnReasonEnum:See returnCloseReason. 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 | The timestamp in this container indicates when the file was attached to the return request or return request draft. |
|
detail.detail.files .creationDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.files .creationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| detail.detail.files.fileData | string | Conditionally | This field is the base64-encoded binary representation of the file associated with the return request or return request draft. This field is always returned for each file that is attached to a return request or return request draft. |
| detail.detail.files.fileFormat | string | Conditionally |
This enumeration value indicates the file type (like .GIF or .JPG). This field is always returned for each file that is attached to a return request or return request draft.
Applicable values are from FileFormatEnum:See fileFormat. Code so that your app gracefully handles any future changes to this list. |
| detail.detail.files.fileId | string | Conditionally | This is the unique eBay-assigned ID of a file that is associated with the return request or return request draft. This field is always returned for each file that is attached to a return request or return request draft. |
| detail.detail.files.fileName | string | Conditionally | This field contains the name of the uploaded file. This field will be returned if the user has specified a name for the file. |
|
detail.detail.files .filePurpose |
string | Conditionally |
This enumeration value indicates the file's purpose. Files attached to return requests or return request drafts may provide more information about the condition of the item, about the buyer's refund, or about shipment tracking or shipping label. This field is always returned for each file that is attached to a return request or draft.
Applicable values are from FilePurposeEnum: Code so that your app gracefully handles any future changes to this list. |
| detail.detail.files.fileStatus | string | Conditionally |
This enumeration value indicates the current status of the file. This field is always returned for each file that is attached to a return request or return request draft.
Applicable values are from FileStatusEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.files .resizedFileData |
string | Conditionally | This field is the base64-encoded binary representation of the file associated with the return request or return request draft. This field is returned for each file that is attached to a return request or return request draft that has been resized. |
| detail.detail.files.secureUrl | string | Conditionally | This field contains the URL where the uploaded file can be viewed. |
| detail.detail.files.submitter | string | Conditionally |
This enumeration value indicates which party (buyer or seller) submitted the file. This field is always returned for each file that is attached to a return request or return request draft.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
| detail.detail.holdInfo | ReturnHoldInfoType | Conditionally | This container provides information on a hold that has been placed on the return request. This container will only be returned if a hold has been placed on the return request. |
|
detail.detail.holdInfo .holdCreationDate |
DateTime | Conditionally | The timestamp in this container indicates the date/time when the hold on the return request was initiated. |
|
detail.detail.holdInfo .holdCreationDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.holdInfo .holdCreationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail.holdInfo .holdReferenceId |
string | Conditionally | This string value is the unique eBay-assigned ID of the hold on the return request. |
|
detail.detail.holdInfo .holdReleaseDate |
DateTime | Conditionally | The timestamp in this container indicates the date/time when the hold on the return request is expected to get released. |
|
detail.detail.holdInfo .holdReleaseDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.holdInfo .holdReleaseDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
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: 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 eBay-assigned ID of the transaction that is a part of the return request. |
| detail.detail.itemDetail | ItemDetailType | Always | This container consists of information about the order line item, including listing ID, transaction ID, price, and quantity being returned. |
|
detail.detail.itemDetail .ebayPlusTxn |
boolean | Conditionally | This field indicates if the order line item was part of an eBay Plus order. eBay Plus is currently available on the eBay Australia and eBay Germany marketplaces. |
|
detail.detail.itemDetail .itemId |
string | Always | The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order. |
|
detail.detail.itemDetail .itemOnHold |
boolean | Conditionally | This field indicates the item related to the return is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding item is on hold due to eBay policy violation; false otherwise. |
|
detail.detail.itemDetail .itemPicUrl |
string | Conditionally | The URL of the gallery image for the listing. This field is returned when available. If the item is on hold, the returned value will be masked. |
|
detail.detail.itemDetail .itemPrice |
Amount | Conditionally | Shows the price of the item. If currency conversion was needed, the original currency and the exchange rate used are also shown. |
|
detail.detail.itemDetail .itemPrice .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.itemDetail .itemPrice.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.itemDetail .itemPrice.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.itemDetail .itemPrice.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.itemDetail .itemPrice.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.itemDetail .itemTitle |
string | Conditionally | The title of the eBay listing. If the item is on hold, the returned value will be masked. |
|
detail.detail.itemDetail .listingSiteId |
integer | Conditionally | This integer value indicates the eBay marketplace where the sale occurred. The site IDs used for each eBay marketplace can be found in the eBay Site ID to Global ID Mapping page. |
|
detail.detail.itemDetail .relistedItemId |
string | Conditionally | This field is only returned if the returned item is relisted as a new eBay listing, and this value will be different than the value in the itemId field. |
|
detail.detail.itemDetail .relistStatus |
string | Conditionally |
This enumeration value either indicates if the order line item is eligible to be relisted, or in a case where the seller wants to relist the item, the value returned here will indicate if relisting was successful or if it failed.
Applicable values are from RelistStatusEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.itemDetail .returnQuantity |
integer | Always |
This integer value indicates the quantity of the order line item being returned. This number is typically 1, unless the buyer bought multiple quantity of the same line item in a multiple-quantity, fixed-price listing.
|
|
detail.detail.itemDetail .transactionDate |
DateTime | Conditionally | This timestamp indicates when the sales transaction occurred. |
|
detail.detail.itemDetail .transactionDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.itemDetail .transactionDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail.itemDetail .transactionId |
string | Always | The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order. |
| detail.detail.marketplaceId | string | Conditionally |
The unique eBay-assigned ID 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 ret:MoneyMovementDetailType | Conditionally | This array consists of detailed information on each monetary transaction that may occur with a return request. |
|
detail.detail .moneyMovementInfo .actualAmount |
Amount | Conditionally |
This container shows 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, the expected amount of the monetary transaction can be seen in the requestedAmount field.
|
|
detail.detail .moneyMovementInfo .actualAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .moneyMovementInfo .actualAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail .moneyMovementInfo .actualAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .moneyMovementInfo .actualAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail .moneyMovementInfo .actualAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail .moneyMovementInfo .creationDate |
DateTime | Conditionally | The timestamp in this container indicates the date and time when the monetary transaction occurred. |
|
detail.detail .moneyMovementInfo .creationDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .moneyMovementInfo .creationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .moneyMovementInfo .externalPaymentId |
string | Conditionally | This string value is the unique ID of a monetary transaction that occurred outside of eBay's system. |
|
detail.detail .moneyMovementInfo .moneyMovementType |
string | Always |
This enumeration value indicates the type of monetary transaction that is either in the process of being executed or has already been executed. The supported enumeration values representing monetary transactions are defined in the MoneyMovementTypeEnum type definition. Applicable values: See ret:MoneyMovementTypeEnum |
|
detail.detail .moneyMovementInfo .paymentProvider |
string | Conditionally |
This enumeration value indicates the external payment system used for the monetary transaction. If returned, the value of this field should be UNKNOWN.
Applicable values are from PaymentProviderEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .moneyMovementInfo .requestedAmount |
Amount | Always |
This container shows the monetary amount of the transaction. This field is returned regardless of the value shown in the moneyMovementStatusType field. The actualAmount field displays only when the monetary transaction was confirmed to be successful (moneyMovementStatusType equals SUCCESS.
|
|
detail.detail .moneyMovementInfo .requestedAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .moneyMovementInfo .requestedAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail .moneyMovementInfo .requestedAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .moneyMovementInfo .requestedAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail .moneyMovementInfo .requestedAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail .moneyMovementInfo.status |
string | Conditionally |
This enumeration value indicates the success or failure of the monetary transaction. The enumeration values that may be returned in this field are defined in the MoneyMovementStatusEnum type definition. Applicable values: See ret:MoneyMovementStatusEnum |
| detail.detail.payoutRecoupInfo | ReturnPayoutRecoupInfoType | Conditionally |
This container indicates the amount that eBay needs to recoup from the seller for a buyer refund, and if this money will be recouped through a seller payout, the payoutId value is returned. This container is returned only if a refund has been automatically issued to the buyer by eBay. |
|
detail.detail.payoutRecoupInfo .amountToRecoup |
Amount | Conditionally | This container shows the amount of money that eBay needs to recoup from the seller to fund a buyer refund. |
|
detail.detail.payoutRecoupInfo .amountToRecoup .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.payoutRecoupInfo .amountToRecoup .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.payoutRecoupInfo .amountToRecoup.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.payoutRecoupInfo .amountToRecoup.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.payoutRecoupInfo .amountToRecoup.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.payoutRecoupInfo .payoutId |
integer | Conditionally |
A unique eBay-assigned ID that identifies the seller payout that is associated with the purchase of the line item. The seller payout that is associated with the purchase of the line item will often by used as the funding source if payout funds are still available. The seller's funding source for a buyer refund is shown in the fundingSource.type field. |
| detail.detail.refundInfo | RefundInfoType | Conditionally | This container provides detailed information on the estimated and actual refund amounts, as well as the seller's funding source(s) used for the buyer refund. |
|
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.donationAmount |
Amount | Conditionally |
This container defines the refund amount for listings that included a charitable donation. This data includes the amount of the charitable donation refund, as well as currency conversion information when necessary including the current currency code, the value in the original currency, and the original currency's code. Note: This container is not applicable for the following methods:
|
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.donationAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.donationAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.donationAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.donationAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.donationAmount .value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount |
Amount | Conditionally | This container shows the total amount of fees credited towards this refund as per eBay policy. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount .value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
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 method to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent method to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} methods, this container will be returned under the actualRefund container if a refund has occurred. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount |
Amount | Conditionally | This container shows 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 method, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent method, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, and one for original shipping. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
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 method, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent method, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, and one for original shipping. The supported enumeration values representing refund fee types are defined in the RefundFeeTypeEnum type definition. Applicable values: See RefundFeeTypeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .restockingFeePercentage |
string | Conditionally | THIS FIELD IS DEPRECATED. DO NOT USE. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.totalAmount |
Amount | Conditionally | This container shows 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 method to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent method to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} methods, this container will be returned under the actualRefund container if a refund has occurred. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.totalAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.totalAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.totalAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.totalAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail .actualRefund.totalAmount .value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .actualRefundDetail.fundings |
array of RefundFundingType | Conditionally | This array shows more information about how the buyer refund was funded. There are multiple seller payment sources where the money can come from, and it is possible that the money can come from multiple seller payment sources. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .amount |
Amount | Conditionally | This container shows the amount debited/charged to the seller's funding source for the buyer refund. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .amount.convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail.fundings .amount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .amount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail.fundings .amount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .amount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .date |
DateTime | Conditionally | The timestamp in this container indicates when the seller's funding source was debited/charged for the buyer refund. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .date.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .date.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail.refundInfo .actualRefundDetail.fundings .fundingSource |
FundingSourceType | Conditionally | This container provides information about the seller's funding source for the buyer refund. A funding source can be available seller payout funds, a bank account on file, or a credit card on file. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .fundingSource.brand |
string | Conditionally |
The enumeration value here indicates the brand of credit card used to fund the buyer's refund. This field is only returned if the funding source type is CREDIT_CARD.
Applicable values are from FundingMethodBrandEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .fundingSource.memo |
string | Conditionally | This provides a note about the funding source. This field is only returned if available, or it might get returned as an empty string. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .fundingSource.type |
string | Conditionally |
The enumeration value here indicates the type of funding source, such as bank account, credit card, or available seller payout funds.
Applicable values are from FundingMethodTypeEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.refundInfo .actualRefundDetail.fundings .fundingStatus |
string | Conditionally |
The enumeration value returned in this field indicates if the debit/charge to the funding source was successful or not.
Applicable values are from FundingStatusEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.refundInfo .actualRefundDetail .netChargeAmount |
Amount | Conditionally | This container shows the total amount charged to the seller for this refund. The value will be in the seller's default currency. |
|
detail.detail.refundInfo .actualRefundDetail .netChargeAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .netChargeAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail .netChargeAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .netChargeAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail .netChargeAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .actualRefundDetail .outstandingAmount |
Amount | Conditionally |
This container shows any outstanding dollar amount that is still due to the buyer for the refund. If a full refund has been successfully issued to the buyer, this value should be 0.0.
|
|
detail.detail.refundInfo .actualRefundDetail .outstandingAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .outstandingAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .actualRefundDetail .outstandingAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .actualRefundDetail .outstandingAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .actualRefundDetail .outstandingAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
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 by eBay.
Applicable values are from ReturnRefundInitiatorEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.refundInfo .actualRefundDetail .refundIssuedDate |
DateTime | Conditionally | The timestamp in this container indicates when the seller issued the refund to the buyer. |
|
detail.detail.refundInfo .actualRefundDetail .refundIssuedDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.refundInfo .actualRefundDetail .refundIssuedDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail.refundInfo .actualRefundDetail .refundStatus |
string | Conditionally |
The enumeration value in this field indicates whether or not the refund operation was successful. If the PENDING value is returned, it indicates that the refund may be occurring outside of eBay's system 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 are from Refund_MoneyMovementStatusEnum: Code so that your app gracefully handles any future changes to this list. |
|
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 array shows the estimated amounts for one or more refunds that the seller may have to issue to a buyer in a return request. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount |
Amount | Always | This container shows the estimated amount of the refund. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount |
Amount | Always | This container shows the maximum amount that the refund could be based on the cost of the order. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount |
Amount | Always | This container shows the minimum amount that the refund could be based on the cost of the order. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .purchasePriceDeductedPercentageList |
array of integer | Conditionally | This array shows one or more percentage values, and these values indicate the percentage value(s) deducted off of the purchase price. |
|
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 method, 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 | Conditionally | THIS FIELD IS DEPRECATED. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems |
array of EstimatedRefundType | Conditionally | This array shows the different refund types and associated costs that the seller can voluntarily issue to the buyer at his/her discretion. The seller is not obligated to issue any of the refund types in this array, but might do so as a matter of good customer service. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount |
Amount | Always | This container shows the estimated amount of the refund. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount |
Amount | Always | This container shows the maximum amount that the refund could be based on the cost of the order. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount |
Amount | Always | This container shows the minimum amount that the refund could be based on the cost of the order. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .purchasePriceDeductedPercentageList |
array of integer | Conditionally | This array shows one or more percentage values, and these values indicate the percentage value(s) deducted off of the purchase price. |
|
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 method, 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 | Conditionally | THIS FIELD IS DEPRECATED. |
|
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. This container is only returned if the buyer is requesting a replacement item instead of a refund for the original item. Note: Replacement items for returns are not currently supported. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings |
array of ShipmentTrackingType | Conditionally | This container is an array of shipment tracking information for a return item. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings.active |
boolean | Conditionally | This boolean value indicates whether or not a return request is still in an active state. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .actualDeliveryDate |
DateTime | Conditionally |
The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .actualDeliveryDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .actualShipDate |
DateTime | Conditionally | The timestamp in this container 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 shipped or marked as shipped. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .actualShipDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .actualShipDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .carrierEnum |
string | Conditionally |
This value indicates the shipping carrier used to ship the return item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. 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 shows 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 IS DEPRECATED. SEE actualDeliveryDate FIELD INSTEAD. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .deliveryDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .deliveryDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .deliveryStatus |
string | Conditionally |
This enumeration value indicates the tracking status of the item. This value may get returned as UNKNOWN if shipment tracking has not been provided.
Applicable values are from TrackingStatusEnum: 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 of the item's shipping destination. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .destinationAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .destinationAddress.name |
string | Conditionally | The name/business name associated with the 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 | The timestamp in this container indicates when the shipping label will expire and will no longer be valid to print and use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .labelDate |
DateTime | Conditionally | The timestamp in this container indicates when the shipping label was created. This container is returned if a shipping label exists for the order line item. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .labelDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .labelDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings.labelId |
string | Conditionally | This string value is the unique eBay-assigned ID 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 field will be returned as true if the item has been mark as received by the recipient.
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .maxDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .maxDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .minDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .minDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .originAddress |
ReturnAddressType | Conditionally | This container provides the full address of the item's origin address. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .originAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .originAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .originAddress.name |
string | Conditionally | The name/business name associated with the address |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings.shipDate |
DateTime | Conditionally | THIS FIELD IS DEPRECATED. SEE actualShipDate FIELD INSTEAD. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings.shipDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings.shipDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .shipmentId |
string | Conditionally | This string value is the unique eBay-assigned ID of the shipment. This field is returned if available. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .shippedBy |
string | Conditionally |
This enumeration value indicates the party shipping the item, such as buyer or seller.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .replacementShipmentInfo .allShipmentTrackings .shippingMethod |
string | Conditionally |
This enumeration value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.
Applicable values are from ShippingMethodEnum: 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 |
string | Conditionally |
This enumeration value indicates whether the buyer or seller will be paying for shipment of item.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
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 value indicates whether or not a return request is still in an active state. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .actualDeliveryDate |
DateTime | Conditionally |
The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .actualDeliveryDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking .actualShipDate |
DateTime | Conditionally | The timestamp in this container 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 shipped or marked as shipped. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .actualShipDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .actualShipDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking.carrierEnum |
string | Conditionally |
This value indicates the shipping carrier used to ship the return item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. 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 shows 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 IS DEPRECATED. SEE actualDeliveryDate FIELD INSTEAD. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.deliveryDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.deliveryDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking .deliveryStatus |
string | Conditionally |
This enumeration value indicates the tracking status of the item. This value may get returned as UNKNOWN if shipment tracking has not been provided.
Applicable values are from TrackingStatusEnum: 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 of the item's shipping destination. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .destinationAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .replacementShipmentInfo .shipmentTracking .destinationAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .replacementShipmentInfo .shipmentTracking .destinationAddress.name |
string | Conditionally | The name/business name associated with the 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 | The timestamp in this container indicates when the shipping label will expire and will no longer be valid to print and use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.labelDate |
DateTime | Conditionally | The timestamp in this container indicates when the shipping label was created. This container is returned if a shipping label exists for the order line item. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.labelDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.labelDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking.labelId |
string | Conditionally | This string value is the unique eBay-assigned ID 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 field will be returned as true if the item has been mark as received by the recipient.
|
|
detail.detail .replacementShipmentInfo .shipmentTracking .maxDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .maxDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking .minDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .minDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking .originAddress |
ReturnAddressType | Conditionally | This container provides the full address of the item's origin address. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .originAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .replacementShipmentInfo .shipmentTracking .originAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .replacementShipmentInfo .shipmentTracking .originAddress.name |
string | Conditionally | The name/business name associated with the address |
|
detail.detail .replacementShipmentInfo .shipmentTracking.shipDate |
DateTime | Conditionally | THIS FIELD IS DEPRECATED. SEE actualShipDate FIELD INSTEAD. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.shipDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.shipDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .replacementShipmentInfo .shipmentTracking.shipmentId |
string | Conditionally | This string value is the unique eBay-assigned ID of the shipment. This field is returned if available. |
|
detail.detail .replacementShipmentInfo .shipmentTracking.shippedBy |
string | Conditionally |
This enumeration value indicates the party shipping the item, such as buyer or seller.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .replacementShipmentInfo .shipmentTracking .shippingMethod |
string | Conditionally |
This enumeration value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.
Applicable values are from ShippingMethodEnum: 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 provides the itemized list of costs associated with shipping the item. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost |
array of ItemizedReturnShippingCostType | Conditionally | This container consists of the costs to ship an item. A separate itemizedReturnShippingCost node will be returned 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 container shows the amount for the shipping cost type shown in the returnShippingCostType field. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
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: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost.totalAmount |
Amount | Conditionally | This container shows the total amount of shipping costs associated with 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 |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .replacementShipmentInfo .shippingLabelCost.totalAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost.totalAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .replacementShipmentInfo .shippingLabelCost.totalAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail .replacementShipmentInfo .shippingLabelCost.totalAmount .value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
| detail.detail.responseHistory | array of ReturnResponseHistoryType | Conditionally | This array consists of detailed information of each activity that occurs with a return request. |
|
detail.detail.responseHistory .activity |
string | Conditionally |
This enumeration value indicates the action performed by the buyer, seller, or eBay to move the return request to the next stage. This field is always returned with each action recorded under the responseHistory array.
Applicable values are from ActivityOptionEnum:See activity. Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.responseHistory .attributes |
ResponseHistoryAttributesType | Conditionally | This container consists of various return shipping and buyer refund information, such as the shipping carrier, shipment tracking number, a partial refund amount (if applicable), and a monetary transaction identifier (if applicable). This container will be returned if the the buyer/seller/eBay action (specified in the activity field) requires the data in this container. |
|
detail.detail.responseHistory .attributes.escalateReason |
string | 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. The applicable values are defined in the EscalateReasonEnum type definition. Applicable values: See EscalateReasonEnum |
|
detail.detail.responseHistory .attributes.keepOriginalItem |
boolean | Conditionally |
If set to true, the seller indicates that the buyer can keep the item they received instead of shipping it back to the seller when the refund request is accepted. Default: false
|
|
detail.detail.responseHistory .attributes.moneyMovementRef |
MoneyMovementRef | Conditionally | This container provides the unique eBay-assigned ID of a monetary transaction associated with a return. This container is not returned if no monetary 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 monetary movement transaction. |
|
detail.detail.responseHistory .attributes .partialRefundAmount |
Amount | Conditionally | This container shows 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 |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.responseHistory .attributes .partialRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.responseHistory .attributes .partialRefundAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.responseHistory .attributes .partialRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.responseHistory .attributes .partialRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.responseHistory .attributes .refundDeductionType |
RefundDeductionType | Conditionally |
This container shows the amount/type of deduction that is taken off the refund amount, if any. The deduction amount can be either a percentage off the refund amount or a monetary amount that is deducted. |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionAmount |
Amount | Conditionally |
This container shows the deduction amount that is taken off the refund amount. This container will be returned if a set monetary amount was deducted from the refund amount. |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.detail.responseHistory .attributes .refundDeductionType .refundDeductionPercentage |
integer | Conditionally |
This integer value indicates the percentage value that was deducted from the refund amount. This field will be returned if a percentage value was deducted from the refund amount. |
|
detail.detail.responseHistory .attributes.rlspType |
string | Conditionally |
This field indicates which AU carrier the seller has provided to the buyer for their use.
Applicable values are from RlspTypeEnum: Code so that your app gracefully handles any future changes to this list. |
|
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 where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail.responseHistory .attributes .sellerReturnAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail.responseHistory .attributes .sellerReturnAddress.name |
string | Conditionally | The name/business name associated with the 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). This field will only be returned if necessary/applicable. |
|
detail.detail.responseHistory .attributes .updatedTrackingNumber |
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 |
string | Conditionally |
This enumeration value indicates the actor (such as buyer, seller, or eBay) that performed the action (specified in the activity field). This field is always with each action recorded under the responseHistory array.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.responseHistory .creationDate |
DateTime | Conditionally | The timestamp in this container indicates the date/time when the action (specified in the activity field) was performed. This container is always with each action recorded under the responseHistory array. |
|
detail.detail.responseHistory .creationDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail.responseHistory .creationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail.responseHistory .fromState |
string | Conditionally |
This enumeration value indicates the previous state of the return request before the action (specified in the activity field) was performed. This field is always with each action recorded under the responseHistory array.
Applicable values are from ReturnStateEnum:See fromState. Code so that your app gracefully handles any future changes to this list. |
|
detail.detail.responseHistory .notes |
string | Conditionally | This string value contains a note about the buyer/seller/eBay action (specified in the activity field). This field is only returned if a note exists for the action. |
|
detail.detail.responseHistory .toState |
string | Conditionally |
This enumeration value indicates the new state of the return after the action (specified in the activity field) was performed. This field is always with each action recorded under the responseHistory array.
Applicable values are from ReturnStateEnum:See toState. Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .returnContentOnHold |
boolean | Conditionally | This field indicates the item content related to the return is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding return content is on hold due to eBay policy violation; false otherwise. |
|
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 a return item. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings.active |
boolean | Conditionally | This boolean value indicates whether or not a return request is still in an active state. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .actualDeliveryDate |
DateTime | Conditionally |
The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .actualDeliveryDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .actualShipDate |
DateTime | Conditionally | The timestamp in this container 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 shipped or marked as shipped. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .actualShipDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .actualShipDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .carrierEnum |
string | Conditionally |
This value indicates the shipping carrier used to ship the return item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. 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 shows 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 IS DEPRECATED. SEE actualDeliveryDate FIELD INSTEAD. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .deliveryDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .deliveryDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .deliveryStatus |
string | Conditionally |
This enumeration value indicates the tracking status of the item. This value may get returned as UNKNOWN if shipment tracking has not been provided.
Applicable values are from TrackingStatusEnum: 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 of the item's shipping destination. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .destinationAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .destinationAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .destinationAddress.name |
string | Conditionally | The name/business name associated with the 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 | The timestamp in this container indicates when the shipping label will expire and will no longer be valid to print and use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .labelDate |
DateTime | Conditionally | The timestamp in this container indicates when the shipping label was created. This container is returned if a shipping label exists for the order line item. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .labelDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .labelDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings.labelId |
string | Conditionally | This string value is the unique eBay-assigned ID 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 field will be returned as true if the item has been mark as received by the recipient.
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .maxDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .maxDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .minDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .minDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .originAddress |
ReturnAddressType | Conditionally | This container provides the full address of the item's origin address. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .originAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .originAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .originAddress.name |
string | Conditionally | The name/business name associated with the address |
|
detail.detail .returnShipmentInfo .allShipmentTrackings.shipDate |
DateTime | Conditionally | THIS FIELD IS DEPRECATED. SEE actualShipDate FIELD INSTEAD. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings.shipDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings.shipDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .allShipmentTrackings .shipmentId |
string | Conditionally | This string value is the unique eBay-assigned ID of the shipment. This field is returned if available. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .shippedBy |
string | Conditionally |
This enumeration value indicates the party shipping the item, such as buyer or seller.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .returnShipmentInfo .allShipmentTrackings .shippingMethod |
string | Conditionally |
This enumeration value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.
Applicable values are from ShippingMethodEnum: 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 |
string | Conditionally |
This enumeration value indicates whether the buyer or seller will be paying for shipment of item.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
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 value indicates whether or not a return request is still in an active state. |
|
detail.detail .returnShipmentInfo .shipmentTracking .actualDeliveryDate |
DateTime | Conditionally |
The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking .actualDeliveryDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking .actualShipDate |
DateTime | Conditionally | The timestamp in this container 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 shipped or marked as shipped. |
|
detail.detail .returnShipmentInfo .shipmentTracking .actualShipDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking .actualShipDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking.carrierEnum |
string | Conditionally |
This value indicates the shipping carrier used to ship the return item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. 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 shows 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 IS DEPRECATED. SEE actualDeliveryDate FIELD INSTEAD. |
|
detail.detail .returnShipmentInfo .shipmentTracking.deliveryDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking.deliveryDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking .deliveryStatus |
string | Conditionally |
This enumeration value indicates the tracking status of the item. This value may get returned as UNKNOWN if shipment tracking has not been provided.
Applicable values are from TrackingStatusEnum: 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 of the item's shipping destination. |
|
detail.detail .returnShipmentInfo .shipmentTracking .destinationAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .returnShipmentInfo .shipmentTracking .destinationAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .returnShipmentInfo .shipmentTracking .destinationAddress.name |
string | Conditionally | The name/business name associated with the 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 | The timestamp in this container indicates when the shipping label will expire and will no longer be valid to print and use. |
|
detail.detail .returnShipmentInfo .shipmentTracking.labelDate |
DateTime | Conditionally | The timestamp in this container indicates when the shipping label was created. This container is returned if a shipping label exists for the order line item. |
|
detail.detail .returnShipmentInfo .shipmentTracking.labelDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking.labelDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking.labelId |
string | Conditionally | This string value is the unique eBay-assigned ID 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 field will be returned as true if the item has been mark as received by the recipient.
|
|
detail.detail .returnShipmentInfo .shipmentTracking .maxDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking .maxDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking .minDeliveryEstimate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking .minDeliveryEstimate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking .originAddress |
ReturnAddressType | Conditionally | This container provides the full address of the item's origin address. |
|
detail.detail .returnShipmentInfo .shipmentTracking .originAddress.address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
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 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail .returnShipmentInfo .shipmentTracking .originAddress.address .worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail .returnShipmentInfo .shipmentTracking .originAddress.name |
string | Conditionally | The name/business name associated with the address |
|
detail.detail .returnShipmentInfo .shipmentTracking.shipDate |
DateTime | Conditionally | THIS FIELD IS DEPRECATED. SEE actualShipDate FIELD INSTEAD. |
|
detail.detail .returnShipmentInfo .shipmentTracking.shipDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.detail .returnShipmentInfo .shipmentTracking.shipDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.detail .returnShipmentInfo .shipmentTracking.shipmentId |
string | Conditionally | This string value is the unique eBay-assigned ID of the shipment. This field is returned if available. |
|
detail.detail .returnShipmentInfo .shipmentTracking.shippedBy |
string | Conditionally |
This enumeration value indicates the party shipping the item, such as buyer or seller.
Applicable values are from ReturnUserRoleEnum: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .returnShipmentInfo .shipmentTracking .shippingMethod |
string | Conditionally |
This enumeration value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.
Applicable values are from ShippingMethodEnum: 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 provides the itemized list of costs associated with shipping the item. |
|
detail.detail .returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost |
array of ItemizedReturnShippingCostType | Conditionally | This container consists of the costs to ship an item. A separate itemizedReturnShippingCost node will be returned 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 container shows the amount for the shipping cost type shown in the returnShippingCostType field. |
|
detail.detail .returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail .returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail .returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
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: Code so that your app gracefully handles any future changes to this list. |
|
detail.detail .returnShipmentInfo .shippingLabelCost.totalAmount |
Amount | Conditionally | This container shows the total amount of shipping costs associated with 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 |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .returnShipmentInfo .shippingLabelCost.totalAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.detail .returnShipmentInfo .shippingLabelCost.totalAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.detail .returnShipmentInfo .shippingLabelCost.totalAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.detail .returnShipmentInfo .shippingLabelCost.totalAmount .value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
| detail.detail.RMANumber | 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.sellerAddress | ReturnAddressType | Conditionally |
This container provides the seller's default shipping address. This container is only returned if the buyer is expected to return the item before receiving a refund. |
|
detail.detail.sellerAddress .address |
Address | Conditionally | This container holds the address where a return item will be shipped. |
|
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 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, PO Box, or other type of address. This field is not always used by containers using the Address type. The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition. Applicable values: See AddressTypeEnum |
|
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. The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition. Applicable values: See CountryCodeEnum |
|
detail.detail.sellerAddress .address.county |
string | Conditionally | The county of the address. This field is not always used, but it should be provided 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 country 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.The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
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. The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition. Applicable values: See LanguageScriptEnum |
|
detail.detail.sellerAddress .address.worldRegion |
string | Conditionally |
This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type. The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition. Applicable values: See WorldRegionEnum |
|
detail.detail.sellerAddress .name |
string | Conditionally | The name/business name associated with the 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 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 array consists one or more options that are available to the buyer to move the return request to the next stage. If the return request is currently waiting for a response from the seller, this array may not appear at all. |
|
detail.summary .buyerAvailableOptions .actionType |
string | Always |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage. Note that most values in the ActivityOptionEnum type are either specific to the buyer or the seller, but not to both.
Applicable values are from ActivityOptionEnum:See actionType. Code so that your app gracefully handles any future changes to this list. |
|
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 the next action the buyer is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the buyer. |
|
detail.summary .buyerResponseDue.activityDue |
string | Conditionally |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage.
Applicable values are from ActivityOptionEnum:See activityDue. Code so that your app gracefully handles any future changes to this list. |
|
detail.summary .buyerResponseDue .respondByDate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.summary .buyerResponseDue .respondByDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.summary .buyerTotalRefund |
TotalRefundAmountType | Conditionally |
This container returns the total refund amount for the buyer. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued. In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from eBay instead of from the seller. |
|
detail.summary .buyerTotalRefund .actualRefundAmount |
Amount | Conditionally | This container shows the actual refund amount paid to the buyer. Is is only returned after a refund has been issued to the buyer. |
|
detail.summary .buyerTotalRefund .actualRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .buyerTotalRefund .actualRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.summary .buyerTotalRefund .actualRefundAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .buyerTotalRefund .actualRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.summary .buyerTotalRefund .actualRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.summary .buyerTotalRefund .estimatedRefundAmount |
Amount | Always | This container shows the estimated refund amount expected to be paid to the buyer. |
|
detail.summary .buyerTotalRefund .estimatedRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .buyerTotalRefund .estimatedRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.summary .buyerTotalRefund .estimatedRefundAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .buyerTotalRefund .estimatedRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.summary .buyerTotalRefund .estimatedRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
| 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 and the reason for the return. |
|
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
|
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
|
detail.summary.creationInfo .creationDate |
DateTime | Always | The timestamp in this container indicates the date/time when the return request was created. |
|
detail.summary.creationInfo .creationDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.summary.creationInfo .creationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
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 | Always | The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order. |
|
detail.summary.creationInfo .item.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.
|
|
detail.summary.creationInfo .item.transactionId |
string | Always | The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order. |
|
detail.summary.creationInfo .reason |
string | Always |
This enumerated value indicates the buyer's reason for creating a return request or draft. The supported enumeration values representing valid return reasons are defined in the ReturnReasonEnum type definition. Applicable values: See ReturnReasonEnum |
|
detail.summary.creationInfo .reasonType |
string | Conditionally |
This value indicates the broad reason why the buyer is opening the return request, such as SNAD or REMORSE.
Applicable values are from ReturnReasonTypeEnum: 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. Note: Currently, the only supported value is Applicable values are from ReturnTypeEnum: Note: This value is deprecated. Note: This value is not currently supported. Note: This value is deprecated. 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. Note: Currently, the only supported value is Applicable values are from ReturnTypeEnum: Note: This value is deprecated. Note: This value is not currently supported. Note: This value is deprecated. 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 return request to a 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 containers.
|
|
detail.summary.escalationInfo .buyerEscalationEligibilityInfo .endTime |
DateTime | Conditionally |
The timestamp in this container provides the deadline in which the buyer or seller may escalate the return request to a case. As soon as this time expires, the buyer or seller may no longer escalate the return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
detail.summary.escalationInfo .buyerEscalationEligibilityInfo .endTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.summary.escalationInfo .buyerEscalationEligibilityInfo .endTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.summary.escalationInfo .buyerEscalationEligibilityInfo .startTime |
DateTime | Conditionally |
The timestamp in this container provides the earliest date in which the buyer or seller may escalate the return request to a 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 return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
detail.summary.escalationInfo .buyerEscalationEligibilityInfo .startTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.summary.escalationInfo .buyerEscalationEligibilityInfo .startTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.summary.escalationInfo .caseId |
string | Conditionally | The unique eBay-assigned ID 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 return request to a 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 containers.
|
|
detail.summary.escalationInfo .sellerEscalationEligibilityInfo .endTime |
DateTime | Conditionally |
The timestamp in this container provides the deadline in which the buyer or seller may escalate the return request to a case. As soon as this time expires, the buyer or seller may no longer escalate the return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
detail.summary.escalationInfo .sellerEscalationEligibilityInfo .endTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.summary.escalationInfo .sellerEscalationEligibilityInfo .endTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.summary.escalationInfo .sellerEscalationEligibilityInfo .startTime |
DateTime | Conditionally |
The timestamp in this container provides the earliest date in which the buyer or seller may escalate the return request to a 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 return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
detail.summary.escalationInfo .sellerEscalationEligibilityInfo .startTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.summary.escalationInfo .sellerEscalationEligibilityInfo .startTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| detail.summary.orderId | string | Conditionally | The unique eBay-assigned ID of the order being returned. |
| detail.summary.returnId | string | Conditionally | The unique eBay-assigned ID 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 method 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 method to provide the buyer with the RMA number for the item.
|
|
detail.summary .sellerAvailableOptions |
array of AvailableOptionType | Conditionally | This array consists one or more options that are available to the seller to move the return request to the next stage. If the return request is currently waiting for a response from the buyer, this array may not appear at all. |
|
detail.summary .sellerAvailableOptions .actionType |
string | Always |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage. Note that most values in the ActivityOptionEnum type are either specific to the buyer or the seller, but not to both.
Applicable values are from ActivityOptionEnum:See actionType. Code so that your app gracefully handles any future changes to this list. |
|
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 the next action the seller is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the seller. |
|
detail.summary .sellerResponseDue.activityDue |
string | Conditionally |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage.
Applicable values are from ActivityOptionEnum:See activityDue. Code so that your app gracefully handles any future changes to this list. |
|
detail.summary .sellerResponseDue .respondByDate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
detail.summary .sellerResponseDue .respondByDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
detail.summary .sellerTotalRefund |
TotalRefundAmountType | Conditionally |
This container returns the total buyer refund amount due from the seller. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued. In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from eBay instead of from the seller. |
|
detail.summary .sellerTotalRefund .actualRefundAmount |
Amount | Conditionally | This container shows the actual refund amount paid to the buyer. Is is only returned after a refund has been issued to the buyer. |
|
detail.summary .sellerTotalRefund .actualRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .sellerTotalRefund .actualRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.summary .sellerTotalRefund .actualRefundAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .sellerTotalRefund .actualRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.summary .sellerTotalRefund .actualRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
detail.summary .sellerTotalRefund .estimatedRefundAmount |
Amount | Always | This container shows the estimated refund amount expected to be paid to the buyer. |
|
detail.summary .sellerTotalRefund .estimatedRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .sellerTotalRefund .estimatedRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
detail.summary .sellerTotalRefund .estimatedRefundAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
detail.summary .sellerTotalRefund .estimatedRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
detail.summary .sellerTotalRefund .estimatedRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
| detail.summary.state | string | Conditionally |
This enumeration value indicates the current state of the return request.
Applicable values are from ReturnStateEnum:See state. Code so that your app gracefully handles any future changes to this list. |
| detail.summary.status | string | Conditionally |
This enumeration value indicates the current status of the return request.
Applicable values are from ReturnStatusEnum:See status. Code so that your app gracefully handles any future changes to this list. |
| detail.summary.timeoutDate | DateTime | Conditionally | The timestamp in this container indicates the date and time when eBay may administratively close the return request is either a buyer's or seller's response is nor made by this deadline. |
|
detail.summary.timeoutDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
detail.summary.timeoutDate .value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| 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 array contains the results of one or more return eligibility check types for the line, including any errors that may have occurred with the check type. |
|
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 method, multiple eligibility checks can be run against the order line item, but the POST /post-order/v2/return method only uses the RETURN_CREATION check.
Applicable values are from ret:EligibilityCheckTypeEnum:See checkType. 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 return 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 eBay-assigned ID 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 array may consist of one or more errors that may have occurred with the return eligibility check. This array is only returned if one or more return eligibility check errors occurred. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .eligibilityErrorDetail .eligibilityError |
EligibilityErrorType | Conditionally |
This container provides information on an error that occurred in regards to an order line item being eligible for a return request. This container is only returned if one or more errors occur with an item eligibility check. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .eligibilityErrorDetail .eligibilityError.code |
string | Conditionally | A unique eBay-assigned ID of the error. |
|
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 error. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .eligibilityStatus |
string | Always |
This enumeration value indicates the success or failure of a return eligibility check. See StatusType for the description of the supported values.
Applicable values are from StatusType: Code so that your app gracefully handles any future changes to this list. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .eligibleStartDate |
DateTime | Conditionally | The timestamp in this container indicates when the buyer is first eligible to create a return request for a item. This field is not returned if the buyer is not eligible to return the item. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .eligibleStartDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .eligibleStartDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .returnCreationDate |
DateTime | Conditionally | The timestamp in this container indicates the date/time when the return request was created. This field is only returned if a return request was successfully created. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .returnCreationDate .formattedValue |
string | Conditionally | Reserved for future use. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .returnCreationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .returnDeadline |
DateTime | Always | The timestamp in this container indicates the deadline for which the buyer must file a return request. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .returnDeadline.formattedValue |
string | Conditionally | Reserved for future use. |
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo .returnDeadline.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
eligibilityResult .eligibilityResultsPerCheckType .eligibilityInfo.returnId |
string | Conditionally | The unique eBay-assigned ID of the newly-created return request. This field is only returned if a return request was successfully created. |
| eligibilityResult.returnItem | ReturnEligibilityItemType | Always | This container consists of summary information on the line item being checked for return eligibility. |
|
eligibilityResult.returnItem .itemId |
string | Always | The unique identifier of the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order. |
|
eligibilityResult.returnItem .reason |
string | Always |
This enumerated value lists indicates the buyer's reason for returning the item. The supported enumeration values representing valid return reasons are defined in the ReturnReasonEnum type definition. Applicable values: See ReturnReasonEnum |
|
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 | The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order. |
| returnId | string | Conditionally | The unique eBay-assigned ID 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 array consists one or more options that are available to the buyer to move the return request to the next stage. If the return request is currently waiting for a response from the seller, this array may not appear at all. |
|
summary.buyerAvailableOptions .actionType |
string | Always |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage. Note that most values in the ActivityOptionEnum type are either specific to the buyer or the seller, but not to both.
Applicable values are from ActivityOptionEnum:See actionType. Code so that your app gracefully handles any future changes to this list. |
|
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 the next action the buyer is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the buyer. |
|
summary.buyerResponseDue .activityDue |
string | Conditionally |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage.
Applicable values are from ActivityOptionEnum:See activityDue. Code so that your app gracefully handles any future changes to this list. |
|
summary.buyerResponseDue .respondByDate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
summary.buyerResponseDue .respondByDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| summary.buyerTotalRefund | TotalRefundAmountType | Conditionally |
This container returns the total refund amount for the buyer. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued. In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from eBay instead of from the seller. |
|
summary.buyerTotalRefund .actualRefundAmount |
Amount | Conditionally | This container shows the actual refund amount paid to the buyer. Is is only returned after a refund has been issued to the buyer. |
|
summary.buyerTotalRefund .actualRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.buyerTotalRefund .actualRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
summary.buyerTotalRefund .actualRefundAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.buyerTotalRefund .actualRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
summary.buyerTotalRefund .actualRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
summary.buyerTotalRefund .estimatedRefundAmount |
Amount | Always | This container shows the estimated refund amount expected to be paid to the buyer. |
|
summary.buyerTotalRefund .estimatedRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.buyerTotalRefund .estimatedRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
summary.buyerTotalRefund .estimatedRefundAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.buyerTotalRefund .estimatedRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
summary.buyerTotalRefund .estimatedRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
| 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 and the reason for the return. |
| 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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
|
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
|
summary.creationInfo .creationDate |
DateTime | Always | The timestamp in this container indicates the date/time when the return request was created. |
|
summary.creationInfo .creationDate.formattedValue |
string | Conditionally | Reserved for future use. |
|
summary.creationInfo .creationDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| 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 | Always | The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order. |
|
summary.creationInfo.item .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.
|
|
summary.creationInfo.item .transactionId |
string | Always | The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order. |
| summary.creationInfo.reason | string | Always |
This enumerated value indicates the buyer's reason for creating a return request or draft. The supported enumeration values representing valid return reasons are defined in the ReturnReasonEnum type definition. Applicable values: See ReturnReasonEnum |
|
summary.creationInfo .reasonType |
string | Conditionally |
This value indicates the broad reason why the buyer is opening the return request, such as SNAD or REMORSE.
Applicable values are from ReturnReasonTypeEnum: 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. Note: Currently, the only supported value is Applicable values are from ReturnTypeEnum: Note: This value is deprecated. Note: This value is not currently supported. Note: This value is deprecated. 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. Note: Currently, the only supported value is Applicable values are from ReturnTypeEnum: Note: This value is deprecated. Note: This value is not currently supported. Note: This value is deprecated. 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 return request to a 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 containers.
|
|
summary.escalationInfo .buyerEscalationEligibilityInfo .endTime |
DateTime | Conditionally |
The timestamp in this container provides the deadline in which the buyer or seller may escalate the return request to a case. As soon as this time expires, the buyer or seller may no longer escalate the return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
summary.escalationInfo .buyerEscalationEligibilityInfo .endTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
summary.escalationInfo .buyerEscalationEligibilityInfo .endTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
summary.escalationInfo .buyerEscalationEligibilityInfo .startTime |
DateTime | Conditionally |
The timestamp in this container provides the earliest date in which the buyer or seller may escalate the return request to a 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 return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
summary.escalationInfo .buyerEscalationEligibilityInfo .startTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
summary.escalationInfo .buyerEscalationEligibilityInfo .startTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| summary.escalationInfo.caseId | string | Conditionally | The unique eBay-assigned ID 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 return request to a 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 containers.
|
|
summary.escalationInfo .sellerEscalationEligibilityInfo .endTime |
DateTime | Conditionally |
The timestamp in this container provides the deadline in which the buyer or seller may escalate the return request to a case. As soon as this time expires, the buyer or seller may no longer escalate the return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
summary.escalationInfo .sellerEscalationEligibilityInfo .endTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
summary.escalationInfo .sellerEscalationEligibilityInfo .endTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
|
summary.escalationInfo .sellerEscalationEligibilityInfo .startTime |
DateTime | Conditionally |
The timestamp in this container provides the earliest date in which the buyer or seller may escalate the return request to a 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 return request to a case. This field will not be returned if the value of the eligible field is false.
|
|
summary.escalationInfo .sellerEscalationEligibilityInfo .startTime.formattedValue |
string | Conditionally | Reserved for future use. |
|
summary.escalationInfo .sellerEscalationEligibilityInfo .startTime.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| summary.orderId | string | Conditionally | The unique eBay-assigned ID of the order being returned. |
| summary.returnId | string | Conditionally | The unique eBay-assigned ID 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 method 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 method to provide the buyer with the RMA number for the item.
|
| summary.sellerAvailableOptions | array of AvailableOptionType | Conditionally | This array consists one or more options that are available to the seller to move the return request to the next stage. If the return request is currently waiting for a response from the buyer, this array may not appear at all. |
|
summary.sellerAvailableOptions .actionType |
string | Always |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage. Note that most values in the ActivityOptionEnum type are either specific to the buyer or the seller, but not to both.
Applicable values are from ActivityOptionEnum:See actionType. Code so that your app gracefully handles any future changes to this list. |
|
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 the next action the seller is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the seller. |
|
summary.sellerResponseDue .activityDue |
string | Conditionally |
This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage.
Applicable values are from ActivityOptionEnum:See activityDue. Code so that your app gracefully handles any future changes to this list. |
|
summary.sellerResponseDue .respondByDate |
DateTime | Conditionally | The timestamp in this container 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 | Reserved for future use. |
|
summary.sellerResponseDue .respondByDate.value |
datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| summary.sellerTotalRefund | TotalRefundAmountType | Conditionally |
This container returns the total buyer refund amount due from the seller. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued. In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from eBay instead of from the seller. |
|
summary.sellerTotalRefund .actualRefundAmount |
Amount | Conditionally | This container shows the actual refund amount paid to the buyer. Is is only returned after a refund has been issued to the buyer. |
|
summary.sellerTotalRefund .actualRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.sellerTotalRefund .actualRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
summary.sellerTotalRefund .actualRefundAmount.currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.sellerTotalRefund .actualRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
summary.sellerTotalRefund .actualRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
|
summary.sellerTotalRefund .estimatedRefundAmount |
Amount | Always | This container shows the estimated refund amount expected to be paid to the buyer. |
|
summary.sellerTotalRefund .estimatedRefundAmount .convertedFromCurrency |
string | Conditionally |
The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.sellerTotalRefund .estimatedRefundAmount .convertedFromValue |
number | Conditionally |
The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated. |
|
summary.sellerTotalRefund .estimatedRefundAmount .currency |
string | Conditionally |
A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition. Applicable values: See CurrencyCodeEnum |
|
summary.sellerTotalRefund .estimatedRefundAmount .exchangeRate |
string | Conditionally | This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version. |
|
summary.sellerTotalRefund .estimatedRefundAmount.value |
number | Conditionally | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. |
| summary.state | string | Conditionally |
This enumeration value indicates the current state of the return request.
Applicable values are from ReturnStateEnum:See state. Code so that your app gracefully handles any future changes to this list. |
| summary.status | string | Conditionally |
This enumeration value indicates the current status of the return request.
Applicable values are from ReturnStatusEnum:See status. Code so that your app gracefully handles any future changes to this list. |
| summary.timeoutDate | DateTime | Conditionally | The timestamp in this container indicates the date and time when eBay may administratively close the return request is either a buyer's or seller's response is nor made by this deadline. |
|
summary.timeoutDate .formattedValue |
string | Conditionally | Reserved for future use. |
| summary.timeoutDate.value | datetime | Conditionally |
This timestamp indicates the date and time when an action or event occurred. The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2022-03-20T00:00:00.000Z
|
| Input Output Change History |
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": "3**********4", "transactionId": "8********4", "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": "5********9"
}
| Input Output Samples |
Change History
| Change Date | Description |
|---|---|
| 1.0 2015-06-30 |
|