Get Return

GET /post-order/v2/return/{returnId}

Use this call to retrieve information on a specific return request. The user can retrieve either the full details or a summary of the return.

Input

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/{returnId}?
  fieldgroups=token

URI parameters

Parameter	Type	Required?	Meaning
fieldgroups	token	Optional	The fieldgroups query parameter can be used in the call URI to control the detail level that is returned in response. See the GetReturnFieldGroupEnum type for more information on the values that may be used in this query parameter.
returnId	string	Required	The unique eBay-assigned ID of the return request. This field is required to identify the return request that the user wishes to retrieve.

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

This call has no request payload.

Output

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 GetDetailResponse 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

{ /* GetDetailResponse */
"detail":
    { /* ReturnDetailType */
    "buyerAddress":
        { /* ReturnAddressType */
        "address":
            { /* Address */
            "addressLine1": string,
            "addressLine2": string,
            "addressType": string,
            "city": string,
            "country": string,
            "county": string,
            "isTransliterated": boolean,
            "nationalRegion": string,
            "postalCode": string,
            "script": string,
            "stateOrProvince": string,
            "transliteratedFromScript": string,
            "worldRegion": string
            },
        "name": string
        },
    "buyerLoginName": string,
    "closeInfo":
        { /* ReturnCloseInfoType */
        "buyerCloseComment": string,
        "buyerCloseReason": token,
        "returnCloseDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "returnCloseReason": token
        },
    "files": [
        { /* ReturnFileType */
        "creationDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "fileData": string,
        "fileFormat": token,
        "fileId": string,
        "fileName": string,
        "filePurpose": token,
        "fileStatus": token,
        "resizedFileData": string,
        "secureUrl": string,
        "submitter": token
        }
        /* More ReturnFileType nodes here */
      ],
    "holdInfo":
        { /* ReturnHoldInfoType */
        "holdCreationDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "holdReferenceId": string,
        "holdReleaseDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "holdStatus": token,
        "holdTransactionId": string
        },
    "itemDetail":
        { /* ItemDetailType */
        "ebayPlusTxn": boolean,
        "itemId": string,
        "listingSiteId": integer,
        "relistedItemId": string,
        "relistStatus": token,
        "returnQuantity": integer,
        "transactionId": string
        },
    "marketplaceId": token,
    "moneyMovementInfo": [
        { /* ret:MoneyMovementDetailType */
        "actualAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "creationDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "externalPaymentId": string,
        "moneyMovementType": token,
        "paymentProvider": token,
        "requestedAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "status": token
        }
        /* 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 */
                "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": token,
                    "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": token,
            "refundIssuedDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "refundStatus": token
            },
        "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": token,
                "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": token,
                "restockingFeePercentage": string
                }
                /* More EstimatedRefundType nodes here */
              ]
            }
        },
    "replacementShipmentInfo":
        { /* ShipmentType */
        "allShipmentTrackings": [
            { /* ShipmentTrackingType */
            "active": boolean,
            "actualDeliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "actualShipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "carrierEnum": token,
            "carrierId": integer,
            "carrierName": string,
            "carrierUsed": string,
            "deliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "deliveryStatus": token,
            "destinationAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "errorCode": string,
            "labelAvailableUntilDate": string,
            "labelDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "labelId": string,
            "labelPrintExpired": boolean,
            "labelVoidExpired": boolean,
            "markAsReceived": boolean,
            "maxDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "minDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "originAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "shipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "shipmentId": string,
            "shippedBy": token,
            "shippingMethod": token,
            "trackingNumber": string
            }
            /* More ShipmentTrackingType nodes here */
          ],
        "payee": token,
        "shipmentTracking":
            { /* ShipmentTrackingType */
            "active": boolean,
            "actualDeliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "actualShipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "carrierEnum": token,
            "carrierId": integer,
            "carrierName": string,
            "carrierUsed": string,
            "deliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "deliveryStatus": token,
            "destinationAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "errorCode": string,
            "labelAvailableUntilDate": string,
            "labelDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "labelId": string,
            "labelPrintExpired": boolean,
            "labelVoidExpired": boolean,
            "markAsReceived": boolean,
            "maxDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "minDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "originAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "shipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "shipmentId": string,
            "shippedBy": token,
            "shippingMethod": token,
            "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": token,
        "attributes":
            { /* ResponseHistoryAttributesType */
            "escalateReason": token,
            "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": token,
            "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": token,
        "creationDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "fromState": token,
        "notes": string,
        "toState": token
        }
        /* More ReturnResponseHistoryType nodes here */
      ],
    "returnShipmentInfo":
        { /* ShipmentType */
        "allShipmentTrackings": [
            { /* ShipmentTrackingType */
            "active": boolean,
            "actualDeliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "actualShipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "carrierEnum": token,
            "carrierId": integer,
            "carrierName": string,
            "carrierUsed": string,
            "deliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "deliveryStatus": token,
            "destinationAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "errorCode": string,
            "labelAvailableUntilDate": string,
            "labelDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "labelId": string,
            "labelPrintExpired": boolean,
            "labelVoidExpired": boolean,
            "markAsReceived": boolean,
            "maxDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "minDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "originAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "shipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "shipmentId": string,
            "shippedBy": token,
            "shippingMethod": token,
            "trackingNumber": string
            }
            /* More ShipmentTrackingType nodes here */
          ],
        "payee": token,
        "shipmentTracking":
            { /* ShipmentTrackingType */
            "active": boolean,
            "actualDeliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "actualShipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "carrierEnum": token,
            "carrierId": integer,
            "carrierName": string,
            "carrierUsed": string,
            "deliveryDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "deliveryStatus": token,
            "destinationAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "errorCode": string,
            "labelAvailableUntilDate": string,
            "labelDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "labelId": string,
            "labelPrintExpired": boolean,
            "labelVoidExpired": boolean,
            "markAsReceived": boolean,
            "maxDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "minDeliveryEstimate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "originAddress":
                { /* ReturnAddressType */
                "address":
                    { /* Address */
                    "addressLine1": string,
                    "addressLine2": string,
                    "addressType": string,
                    "city": string,
                    "country": string,
                    "county": string,
                    "isTransliterated": boolean,
                    "nationalRegion": string,
                    "postalCode": string,
                    "script": string,
                    "stateOrProvince": string,
                    "transliteratedFromScript": string,
                    "worldRegion": string
                    },
                "name": string
                },
            "shipDate":
                { /* DateTime */
                "formattedValue": string,
                "value": datetime
                },
            "shipmentId": string,
            "shippedBy": token,
            "shippingMethod": token,
            "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": token,
        "actionURL": string
        }
        /* More AvailableOptionType nodes here */
      ],
    "buyerLoginName": string,
    "buyerResponseDue":
        { /* ReturnResponseDueType */
        "activityDue": token,
        "respondByDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            }
        },
    "buyerTotalRefund":
        { /* TotalRefundAmountType */
        "actualRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "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": token,
        "reasonType": token,
        "type": token
        },
    "currentType": token,
    "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": token,
        "actionURL": string
        }
        /* More AvailableOptionType nodes here */
      ],
    "sellerLoginName": string,
    "sellerResponseDue":
        { /* ReturnResponseDueType */
        "activityDue": token,
        "respondByDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            }
        },
    "sellerTotalRefund":
        { /* TotalRefundAmountType */
        "actualRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "estimatedRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            }
        },
    "state": token,
    "status": token,
    "timeoutDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        }
    }
}

Response field descriptions

Output Container/Field	Type	Occurrence	Meaning
detail	ReturnDetailType	Conditionally	This container consists of detailed information on the order line item that is associated with the return request. This container is not returned if the fieldgroups query parameter is omitted, or if it is used and its value is set to `SUMMARY` or `NONE`.
detail.buyerAddress	ReturnAddressType	Conditionally	This container provides the buyer's default shipping address.
detail.buyerAddress.address	Address	Conditionally	This container holds the address of the named party.
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.buyerAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.buyerAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
detail.buyerAddress.address .city	string	Conditionally	The city of the address. This field is always used by containers using the Address type.
detail.buyerAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.buyerAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.buyerAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.buyerAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.buyerAddress.address .postalCode	string	Conditionally	The postal code of the address. This field is always used by containers using the Address type.
detail.buyerAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.buyerAddress.address .stateOrProvince	string	Conditionally	The state or province of the address. This field is always used by containers using the Address type.
detail.buyerAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.buyerAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.buyerAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.buyerLoginName	string	Conditionally	This string value is the eBay user name of the buyer.
detail.closeInfo	ReturnCloseInfoType	Conditionally	This container provides information on the buyer's reason for wanting to close the return and the actual reason why the return was closed.
detail.closeInfo .buyerCloseComment	string	Conditionally	This string field holds the comment that the buyer made when closing the return request. This field is only returned if the return request was closed and the buyer made a comment upon closing the return request.
detail.closeInfo .buyerCloseReason	token	Conditionally	This token indicates the reason that the buyer is closing the return request. A buyer would typically close a return request after they receive a refund, a replacement item, or if they initiated the return request by mistake. This field is only returned if the return request was closed. Applicable values: See BuyerCloseReturnReasonEnum
detail.closeInfo .returnCloseDate	DateTime	Conditionally	The date and time the return request was closed. This field is only returned if the return request was closed.
detail.closeInfo .returnCloseDate .formattedValue	string	Conditionally	Reserved for future use.
detail.closeInfo .returnCloseDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.closeInfo .returnCloseReason	token	Conditionally	This enumerated value indicates the reason that the return request is being closed. This field is only returned if the return request was closed. Applicable values: See CloseReturnReasonEnum
detail.files	array of ReturnFileType	Conditionally	An array of one or more files attached to a return request.
detail.files.creationDate	DateTime	Conditionally	This timestamp indicates when the file was attached to the return request or draft.
detail.files.creationDate .formattedValue	string	Conditionally	Reserved for future use.
detail.files.creationDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.files.fileData	string	Conditionally	This field is the base64-encoded binary representation of the file associated with the return request. This field is always returned for each file that is attached to a return request or draft.
detail.files.fileFormat	token	Conditionally	Indicates the file type (like .GIF or .JPG). This field is always returned for each file that is attached to a return request or draft. Applicable values: See FileFormatEnum
detail.files.fileId	string	Conditionally	This is the unique eBay-assigned ID of a file that is associated with the return request. This field is always returned for each file that is attached to a return request or draft.
detail.files.fileName	string	Conditionally	This field contains the name of the uploaded file.
detail.files.filePurpose	token	Conditionally	Indicates whether the file's purpose is to provide more information about the condition of the item, about the 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: See FilePurposeEnum
detail.files.fileStatus	token	Conditionally	Indicates the current status of the file. This field is always returned for each file that is attached to a return request or draft. Applicable values: See FileStatusEnum
detail.files.resizedFileData	string	Conditionally	This field is the base64-encoded binary representation of the file associated with the return request. This field is always returned for each file that is attached to a return request or draft. This field is only returned if the file has been resized.
detail.files.secureUrl	string	Conditionally	This field contains the URL location of the uploaded file.
detail.files.submitter	token	Conditionally	Indicates which party (like buyer or seller) submitted the file. This field is always returned for each file that is attached to a return request or draft. Applicable values: See ReturnUserRoleEnum
detail.holdInfo	ReturnHoldInfoType	Conditionally	This container provides information on a hold that has been placed on the seller's funds. This container will only be returned if a hold has been placed on the seller's funds.
detail.holdInfo .holdCreationDate	DateTime	Conditionally	This timestamp indicates the date/time when the hold on the return request was initiated.
detail.holdInfo .holdCreationDate .formattedValue	string	Conditionally	Reserved for future use.
detail.holdInfo .holdCreationDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.holdInfo .holdReferenceId	string	Conditionally	This string value is the unique eBay-assigned ID of the hold on the return request.
detail.holdInfo .holdReleaseDate	DateTime	Conditionally	This timestamp indicates the date/time when the hold on the return request is expected to get released.
detail.holdInfo .holdReleaseDate .formattedValue	string	Conditionally	Reserved for future use.
detail.holdInfo .holdReleaseDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.holdInfo.holdStatus	token	Conditionally	This enumerated value indicates the current status of the hold on the return request. Applicable values: See ReturnHoldStatusEnum
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.itemDetail	ItemDetailType	Always	This container consists of information about the item, including listing ID, order line item ID, price, transaction date, and quantity being returned.
detail.itemDetail.ebayPlusTxn	boolean	Conditionally	If set to `true`, the transaction is an eBay Plus transaction, available on the `EBAY_AU` and `EBAY_DE` marketplaces.
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.itemDetail .listingSiteId	integer	Conditionally	This value indicates the unique eBay marketplace site ID.
detail.itemDetail .relistedItemId	string	Conditionally	This is the unique eBay-assigned listing ID of the returned item that has been newly relisted.
detail.itemDetail.relistStatus	token	Conditionally	The status of the seller's attempt to relist the item. The status can be either `RELIST_ELIGIBLE`, `SUCCESS`, or `FAILED`. Applicable values: See RelistStatusEnum
detail.itemDetail .returnQuantity	integer	Always	This integer value indicates the quantity of the line item being returned. This number is generally `1`, unless the buyer bought multiple quantity of the line item in a multiple-quantity, fixed-price listing.
detail.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.marketplaceId	token	Conditionally	The unique eBay-assigned ID of the eBay site, such as 'EBAY_US'. Applicable values: See MarketplaceIdEnum
detail.moneyMovementInfo	array of ret:MoneyMovementDetailType	Conditionally	This container consists of detailed information on a money movement transaction. A moneyMovementInfo container is returned for each separate money movement transaction.
detail.moneyMovementInfo .actualAmount	Amount	Conditionally	This dollar value is the actual amount of the monetary transaction. The actualAmount field will only show up if the monetary transaction was confirmed to be successful (moneyMovementStatusType values shows as 'SUCCESS'. Until then, expected amount of the monetary transaction can be seen in the requestedAmount field.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.moneyMovementInfo .creationDate	DateTime	Conditionally	This timestamp indicates the date and time when the monetary transaction occurred.
detail.moneyMovementInfo .creationDate.formattedValue	string	Conditionally	Reserved for future use.
detail.moneyMovementInfo .creationDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.moneyMovementInfo .externalPaymentId	string	Conditionally	This string value is the unique eBay-assigned ID of the PayPal (or other payment provider) transaction.
detail.moneyMovementInfo .moneyMovementType	token	Always	Indicates the type of monetary transaction that is either in the process of being executed or has already executed. Monetary transactions include a seller's partial or full refund to the buyer or the seller receiving the Final Value Fee refund from eBay. Applicable values: See ret:MoneyMovementTypeEnum
detail.moneyMovementInfo .paymentProvider	token	Conditionally	Indicates the external payment system used for the monetary transaction. For all other payment providers except PayPal, this value will be 'OTHER'. Applicable values: See PaymentProviderEnum
detail.moneyMovementInfo .requestedAmount	Amount	Always	This monetary amount is the expected value 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.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.moneyMovementInfo .status	token	Conditionally	Indicates the success or failure of the monetary transaction type noted in the moneyMovementType field. Applicable values: See ret:MoneyMovementStatusEnum
detail.payoutRecoupInfo	ReturnPayoutRecoupInfoType	Conditionally	This field indicates the amount that has been refunded to the buyer, the sum of which needs to be recouped from the seller. The complex type includes the ID of the refund transaction. This field is populated only if a refund has been issued by the payments system to the buyer.
detail.payoutRecoupInfo .amountToRecoup	Amount	Conditionally	The monetary amount of the payout (paid by the payment system to the buyer) to recoup from the seller.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.payoutRecoupInfo .payoutId	integer	Conditionally	An unique eBay-assigned ID that identifies the payout to the buyer.
detail.refundInfo	RefundInfoType	Conditionally	This field contains detailed information on the estimated and actual refund amounts.
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.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.refundInfo .actualRefundDetail .actualRefund.feeCreditAmount	Amount	Conditionally	This container shows the total amount of fees credited towards this refund as per eBay policy. This container is only applicable to managed payments orders.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail	array of ItemizedRefundDetailType	Conditionally	This container is used to declare a refund that is being issued, or has been issued to the buyer. An itemizedRefundDetail container is required for each different refund type, such as purchase price and original shipping. This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund call to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent call to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls, this container will be returned under the actualRefund container if a refund has occurred.
detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundAmount	Amount	Conditionally	This dollar value is the amount of the refund for the particular refund type (specified in the refundFeeType field). When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable).
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .refundFeeType	token	Conditionally	This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). Applicable values: See RefundFeeTypeEnum
detail.refundInfo .actualRefundDetail .actualRefund .itemizedRefundDetail .restockingFeePercentage	string	Conditionally	Restocking fees are no longer supported by eBay. Input values for this field are not read nor returned.
detail.refundInfo .actualRefundDetail .actualRefund.totalAmount	Amount	Conditionally	This value is the total cumulative amount of the refund issued to the buyer. This value should equal the sum of the values in the itemizedRefundDetail.refundAmount field(s). This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund call to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent call to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls, this container will be returned under the actualRefund container if a refund has occurred.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.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. This array is only applicable to and returned for eBay managed payments orders.
detail.refundInfo .actualRefundDetail.fundings .amount	Amount	Conditionally	This container shows the amount of the refund.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .actualRefundDetail.fundings .date	DateTime	Conditionally	This timestamp indicates when the buyer refund was issued.
detail.refundInfo .actualRefundDetail.fundings .date.formattedValue	string	Conditionally	Reserved for future use.
detail.refundInfo .actualRefundDetail.fundings .date.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.refundInfo .actualRefundDetail.fundings .fundingSource	FundingSourceType	Conditionally	This container provides details about the seller's funding source to issue the refund, such as a bank account, a credit card, or available seller payout funds.
detail.refundInfo .actualRefundDetail.fundings .fundingSource.brand	string	Conditionally	The enumeration value here indicates the brand of credit card used to fund the refund. Currently, this field is only returned if the funding source type is `CREDIT_CARD`. Applicable values are from FundingMethodBrandEnum: AMERICAN_EXPRESS This enumeration value indicates that a American Express credit card will be used to fund the refund to the buyer. DISCOVER This enumeration value indicates that a Discover credit card will be used to fund the refund to the buyer. MASTERCARD This enumeration value indicates that a Mastercard credit card will be used to fund the refund to the buyer. VISA This enumeration value indicates that a Visa credit card will be used to fund the refund to the buyer. Code so that your app gracefully handles any future changes to this list.
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.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: AVAILABLE_FUNDS This enumeration value indicates that the refund will be funded by the seller's available payout funds that have not yet been deposited into the seller's bank account. CREDIT_CARD This enumeration value indicates that the seller's credit card will be used to fund the buyer's refund. DIRECT_DEBIT This enumeration value indicates that the seller's bank account on file will be debited to fund the buyer's refund. PAY_UPON_INVOICE This enumeration value indicates that the eBay will cover the buyer's refund, but will bill the seller on the seller's monthly invoice. Code so that your app gracefully handles any future changes to this list.
detail.refundInfo .actualRefundDetail.fundings .fundingStatus	string	Conditionally	The enumeration value returned in this field indicates if the refunded was successful or not. Applicable values are from FundingStatusEnum: FAILED This enumeration value indicates that the refund was not successfully funded, which can mean there were insufficient funds in the account, or that the transaction was blocked for another reason. FUNDED This enumeration value indicates that the buyer refund was successfully funded. Code so that your app gracefully handles any future changes to this list.
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. This container is only applicable to and returned for eBay managed payments orders.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.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.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .actualRefundDetail .refundInitiationType	token	Conditionally	This enumerated value indicates the initiator of the refund. 'SELLER_INITIATED' indicates that the seller initiated the refund, and 'AUTO_REFUND' indicates that the buyer's money was automatically refunded through the PayPal system. Applicable values: See ReturnRefundInitiatorEnum
detail.refundInfo .actualRefundDetail .refundIssuedDate	DateTime	Conditionally	This timestamp indicates when the seller issued the refund to the buyer.
detail.refundInfo .actualRefundDetail .refundIssuedDate .formattedValue	string	Conditionally	Reserved for future use.
detail.refundInfo .actualRefundDetail .refundIssuedDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.refundInfo .actualRefundDetail .refundStatus	token	Conditionally	The value in this field indicates whether or not the refund operation was successful. If the 'PENDING' value is returned, it indicates that the refund is happening outside of PayPal and there is no way for eBay to check the status of the refund. In this scenario, the seller should call POST /post-order/v2/return/{returnId}/mark_refund_sent to mark the refund as sent and/or the buyer should call POST /post-order/v2/return/{returnId}/mark_refund_received to mark the refund as received. Applicable values: See Refund_MoneyMovementStatusEnum
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.refundInfo .estimatedRefundDetail .itemizedRefundDetails	array of EstimatedRefundType	Conditionally	This container shows the estimated refund information before the seller issues a refund to the buyer.
detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount	Amount	Always	This dollar value is the estimated amount of the refund.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount	Amount	Always	This dollar value is the maximum amount that the refund could be based on the cost of the order.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount	Amount	Always	This dollar value is the minimum amount that the refund could be based on the cost of the order.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .estimatedRefundDetail .itemizedRefundDetails .purchasePriceDeductedPercentageList	array of integer	Conditionally	This array shows one or percentage values, and these values indicate the percentage value(s) deducted off of the purchase price.
detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .refundFeeType	token	Always	This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). Applicable values: See RefundFeeTypeEnum
detail.refundInfo .estimatedRefundDetail .itemizedRefundDetails .restockingFeePercentage	string	Conditionally	Restocking fees are no longer supported by eBay. Input values for this field are not read nor returned.
detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems	array of EstimatedRefundType	Conditionally	This container shows the optional refund information that the seller can issue to the buyer at his/her discretion. The seller is not obligated to issue this type of refund, but might do so as a matter of good customer service.
detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount	Amount	Always	This dollar value is the estimated amount of the refund.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount	Amount	Always	This dollar value is the maximum amount that the refund could be based on the cost of the order.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount	Amount	Always	This dollar value is the minimum amount that the refund could be based on the cost of the order.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.refundInfo .estimatedRefundDetail .optionalRefundLineItems .purchasePriceDeductedPercentageList	array of integer	Conditionally	This array shows one or percentage values, and these values indicate the percentage value(s) deducted off of the purchase price.
detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .refundFeeType	token	Always	This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). Applicable values: See RefundFeeTypeEnum
detail.refundInfo .estimatedRefundDetail .optionalRefundLineItems .restockingFeePercentage	string	Conditionally	Restocking fees are no longer supported by eBay. Input values for this field are not read nor returned.
detail.replacementShipmentInfo	ShipmentType	Conditionally	This container consists of detailed information on shipment of a replacement item, including shipment information (return address, shipment tracking, estimated and actual delivery dates, and delivery status), and shipping costs.
detail.replacementShipmentInfo .allShipmentTrackings	array of ShipmentTrackingType	Conditionally	This container is an array of shipment tracking information for one or more items.
detail.replacementShipmentInfo .allShipmentTrackings.active	boolean	Conditionally	This Boolean indicates whether or not a return request is still in an active state.
detail.replacementShipmentInfo .allShipmentTrackings .actualDeliveryDate	DateTime	Conditionally	This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as `DELIVERED`.
detail.replacementShipmentInfo .allShipmentTrackings .actualDeliveryDate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings .actualDeliveryDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .allShipmentTrackings .actualShipDate	DateTime	Conditionally	This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.replacementShipmentInfo .allShipmentTrackings .actualShipDate.formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings .actualShipDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .allShipmentTrackings .carrierEnum	token	Conditionally	Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values. Applicable values: See ShippingCarrierEnum
detail.replacementShipmentInfo .allShipmentTrackings .carrierId	integer	Conditionally	This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.replacementShipmentInfo .allShipmentTrackings .carrierName	string	Conditionally	This field is used to show the name of the shipping carrier. This field is returned if available.
detail.replacementShipmentInfo .allShipmentTrackings .carrierUsed	string	Conditionally	This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.replacementShipmentInfo .allShipmentTrackings .deliveryDate	DateTime	Conditionally	This field has been replaced by actualDeliveryDate.
detail.replacementShipmentInfo .allShipmentTrackings .deliveryDate.formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings .deliveryDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .allShipmentTrackings .deliveryStatus	token	Conditionally	This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded. Applicable values: See TrackingStatusEnum
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped to.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address	Address	Conditionally	This container holds the address of the named party.
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.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .allShipmentTrackings .destinationAddress.name	string	Conditionally	The identity of the party associated with this address.
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.replacementShipmentInfo .allShipmentTrackings .labelAvailableUntilDate	string	Conditionally	This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.replacementShipmentInfo .allShipmentTrackings .labelDate	DateTime	Conditionally	This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.replacementShipmentInfo .allShipmentTrackings .labelDate.formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings .labelDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.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.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.replacementShipmentInfo .allShipmentTrackings .markAsReceived	boolean	Conditionally	This Boolean will be returned as `true` if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.replacementShipmentInfo .allShipmentTrackings .maxDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.replacementShipmentInfo .allShipmentTrackings .maxDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings .maxDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .allShipmentTrackings .minDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.replacementShipmentInfo .allShipmentTrackings .minDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings .minDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .allShipmentTrackings .originAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped from.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.address	Address	Conditionally	This container holds the address of the named party.
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.replacementShipmentInfo .allShipmentTrackings .originAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.replacementShipmentInfo .allShipmentTrackings .originAddress.address.country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.address.county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.replacementShipmentInfo .allShipmentTrackings .originAddress.address.script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.replacementShipmentInfo .allShipmentTrackings .originAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .allShipmentTrackings .originAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.replacementShipmentInfo .allShipmentTrackings.shipDate	DateTime	Conditionally	This field has been replaced by the actualShipDate field.
detail.replacementShipmentInfo .allShipmentTrackings.shipDate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .allShipmentTrackings.shipDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.replacementShipmentInfo .allShipmentTrackings .shippedBy	token	Conditionally	Indicates the party shipping the item, such as buyer or seller. Applicable values: See ReturnUserRoleEnum
detail.replacementShipmentInfo .allShipmentTrackings .shippingMethod	token	Conditionally	This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own. Applicable values: See ShippingMethodEnum
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.replacementShipmentInfo .payee	token	Conditionally	Indicates the party whom is paying for shipping the item, such as buyer or seller. Applicable values: See ReturnUserRoleEnum
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.replacementShipmentInfo .shipmentTracking.active	boolean	Conditionally	This Boolean indicates whether or not a return request is still in an active state.
detail.replacementShipmentInfo .shipmentTracking .actualDeliveryDate	DateTime	Conditionally	This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as `DELIVERED`.
detail.replacementShipmentInfo .shipmentTracking .actualDeliveryDate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking .actualDeliveryDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .shipmentTracking .actualShipDate	DateTime	Conditionally	This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.replacementShipmentInfo .shipmentTracking .actualShipDate.formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking .actualShipDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .shipmentTracking.carrierEnum	token	Conditionally	Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values. Applicable values: See ShippingCarrierEnum
detail.replacementShipmentInfo .shipmentTracking.carrierId	integer	Conditionally	This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.replacementShipmentInfo .shipmentTracking.carrierName	string	Conditionally	This field is used to show the name of the shipping carrier. This field is returned if available.
detail.replacementShipmentInfo .shipmentTracking.carrierUsed	string	Conditionally	This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.replacementShipmentInfo .shipmentTracking.deliveryDate	DateTime	Conditionally	This field has been replaced by actualDeliveryDate.
detail.replacementShipmentInfo .shipmentTracking.deliveryDate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking.deliveryDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .shipmentTracking .deliveryStatus	token	Conditionally	This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded. Applicable values: See TrackingStatusEnum
detail.replacementShipmentInfo .shipmentTracking .destinationAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped to.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.address	Address	Conditionally	This container holds the address of the named party.
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.replacementShipmentInfo .shipmentTracking .destinationAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.replacementShipmentInfo .shipmentTracking .destinationAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.replacementShipmentInfo .shipmentTracking .destinationAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.replacementShipmentInfo .shipmentTracking .destinationAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shipmentTracking .destinationAddress.name	string	Conditionally	The identity of the party associated with this address.
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.replacementShipmentInfo .shipmentTracking .labelAvailableUntilDate	string	Conditionally	This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.replacementShipmentInfo .shipmentTracking.labelDate	DateTime	Conditionally	This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.replacementShipmentInfo .shipmentTracking.labelDate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking.labelDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.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.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.replacementShipmentInfo .shipmentTracking .markAsReceived	boolean	Conditionally	This Boolean will be returned as `true` if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.replacementShipmentInfo .shipmentTracking .maxDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.replacementShipmentInfo .shipmentTracking .maxDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking .maxDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .shipmentTracking .minDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.replacementShipmentInfo .shipmentTracking .minDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking .minDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.replacementShipmentInfo .shipmentTracking .originAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped from.
detail.replacementShipmentInfo .shipmentTracking .originAddress.address	Address	Conditionally	This container holds the address of the named party.
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.replacementShipmentInfo .shipmentTracking .originAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.replacementShipmentInfo .shipmentTracking .originAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.replacementShipmentInfo .shipmentTracking .originAddress.address.country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shipmentTracking .originAddress.address.county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.replacementShipmentInfo .shipmentTracking .originAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.replacementShipmentInfo .shipmentTracking .originAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.replacementShipmentInfo .shipmentTracking .originAddress.address.script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.replacementShipmentInfo .shipmentTracking .originAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shipmentTracking .originAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shipmentTracking .originAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.replacementShipmentInfo .shipmentTracking.shipDate	DateTime	Conditionally	This field has been replaced by the actualShipDate field.
detail.replacementShipmentInfo .shipmentTracking.shipDate .formattedValue	string	Conditionally	Reserved for future use.
detail.replacementShipmentInfo .shipmentTracking.shipDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.replacementShipmentInfo .shipmentTracking.shippedBy	token	Conditionally	Indicates the party shipping the item, such as buyer or seller. Applicable values: See ReturnUserRoleEnum
detail.replacementShipmentInfo .shipmentTracking .shippingMethod	token	Conditionally	This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own. Applicable values: See ShippingMethodEnum
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.replacementShipmentInfo .shippingLabelCost	ReturnShippingCostDetailType	Conditionally	This container provide the itemized list of shipping costs and how much it costs to purchase the shipping label to ship an item.
detail.replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost	array of ItemizedReturnShippingCostType	Conditionally	This container consists of the shipping cost to return ship an item. An itemizedReturnShippingCost container is required for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service.
detail.replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount	Amount	Conditionally	This dollar value indicates the amount for the shipping cost type shown in the returnShippingCostType field.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.replacementShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .returnShippingCostType	string	Conditionally	This enumerated value indicates the type of shipping cost, such as the cost of the shipping label, shipping insurance, or the signature confirmation service. Applicable values are from ReturnShippingCostType: INSURANCE Indicates the shipping cost is the price of shipping insurance if it used to return ship the item back to the seller. LABEL_COST Indicates the shipping cost is the price of the shipping label to return the item to the seller. OTHER Indicates the shipping cost is not classified or is not known. SIGNATURE_CONFIRMATION_COST Indicates the shipping cost is the price to return ship the item to the seller using certified shipping. Code so that your app gracefully handles any future changes to this list.
detail.replacementShipmentInfo .shippingLabelCost.totalAmount	Amount	Conditionally	This value is the total amount of shipping costs associated with return shipping the item. This value should equal the sum of the values in the itemizedReturnShippingCost.amount field(s).
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.responseHistory	array of ReturnResponseHistoryType	Conditionally	This container consists of detailed information of each activity that occurs with a return request. A responseHistory container is returned for each return request activity.
detail.responseHistory .activity	token	Conditionally	This token indicates the action performed by the buyer or seller to move the return request to the next stage. This field is always returned with the responseHistory container. Applicable values: See ActivityOptionEnum
detail.responseHistory .attributes	ResponseHistoryAttributesType	Conditionally	This container consists of various return shipping and refund information, such as shipping carrier, tracking number, a partial refund amount (if applicable), and a money movement transaction identifier (if applicable). This container will be returned if the the buyer/seller action (specified in the activity field) requires the data in this container.
detail.responseHistory .attributes.escalateReason	token	Conditionally	Indicates why the buyer or seller escalated the return request to a return case. This field is only returned if a return request was escalated to a return case. Applicable values: See EscalateReasonEnum
detail.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.responseHistory .attributes.moneyMovementRef	MoneyMovementRef	Conditionally	This container provides the unique eBay-assigned ID of the money movement transaction. This value may be the PayPal transaction ID, or another ID if the money movement transaction did not happen in the PayPal system. This container is not returned if no money movement transaction occurred for this particular return activity (identified in the responseHistory.activity field).
detail.responseHistory .attributes.moneyMovementRef .idref	string	Conditionally	This string value is the unique eBay-assigned ID of the money movement transaction. This value may be the PayPal transaction ID, or another ID if the money movement transaction did not happen in the PayPal system.
detail.responseHistory .attributes .partialRefundAmount	Amount	Conditionally	This dollar value is the partial refund amount that the seller is offering to the buyer in order to settle the return request. This field is not applicable and not returned if the seller is not offering the buyer a partial refund.
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.responseHistory .attributes .refundDeductionType	RefundDeductionType	Conditionally	The type of the 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.responseHistory .attributes .refundDeductionType .refundDeductionAmount	Amount	Conditionally	The deduction amount is a monetary amount that is taken off the refund.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.responseHistory .attributes .refundDeductionType .refundDeductionPercentage	integer	Conditionally	The deduction amount is a percentage that is deducted from the refund amount.
detail.responseHistory .attributes.rlspType	token	Conditionally	This field indicates which AU carrier seller has provided to the buyer for their use. Applicable values: See RlspTypeEnum
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.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.responseHistory .attributes .sellerReturnAddress.address	Address	Conditionally	This container holds the address of the named party.
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.responseHistory .attributes .sellerReturnAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.responseHistory .attributes .sellerReturnAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.responseHistory .attributes .sellerReturnAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.responseHistory .attributes .sellerReturnAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.responseHistory .attributes .sellerReturnAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.responseHistory .attributes .sellerReturnAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.responseHistory .attributes .sellerReturnAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.responseHistory .attributes .sellerReturnAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.responseHistory .attributes .sellerReturnAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.responseHistory .attributes .sellerReturnAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.responseHistory .attributes.toEmailAddress	string	Conditionally	This string value is the email address of the applicable eBay party (the responseHistory.author field identifies this party, such as buyer, seller, eBay).
detail.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.responseHistory.author	token	Conditionally	Indicates the actor (such as buyer, seller, or eBay) that performed the action (specified in the activity field). This field is always returned with the responseHistory container. Applicable values: See ReturnUserRoleEnum
detail.responseHistory .creationDate	DateTime	Conditionally	This timestamp indicates the date/time when the action (specified in the activity field) was performed. This field is always returned with the responseHistory container.
detail.responseHistory .creationDate.formattedValue	string	Conditionally	Reserved for future use.
detail.responseHistory .creationDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.responseHistory .fromState	token	Conditionally	Indicates the previous state of the return before the action (specified in the activity field) was performed. This field is always returned with the responseHistory container. Applicable values: See ReturnStateEnum
detail.responseHistory.notes	string	Conditionally	This string value contains a note about the buyer/seller action (specified in the activity field). This field is only returned if a note exist for the action.
detail.responseHistory.toState	token	Conditionally	Indicates the new state of the return after the action (specified in the activity field) was performed. This field is always returned with the responseHistory container. Applicable values: See ReturnStateEnum
detail.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.returnShipmentInfo .allShipmentTrackings	array of ShipmentTrackingType	Conditionally	This container is an array of shipment tracking information for one or more items.
detail.returnShipmentInfo .allShipmentTrackings.active	boolean	Conditionally	This Boolean indicates whether or not a return request is still in an active state.
detail.returnShipmentInfo .allShipmentTrackings .actualDeliveryDate	DateTime	Conditionally	This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as `DELIVERED`.
detail.returnShipmentInfo .allShipmentTrackings .actualDeliveryDate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings .actualDeliveryDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .allShipmentTrackings .actualShipDate	DateTime	Conditionally	This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.returnShipmentInfo .allShipmentTrackings .actualShipDate.formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings .actualShipDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .allShipmentTrackings .carrierEnum	token	Conditionally	Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values. Applicable values: See ShippingCarrierEnum
detail.returnShipmentInfo .allShipmentTrackings .carrierId	integer	Conditionally	This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.returnShipmentInfo .allShipmentTrackings .carrierName	string	Conditionally	This field is used to show the name of the shipping carrier. This field is returned if available.
detail.returnShipmentInfo .allShipmentTrackings .carrierUsed	string	Conditionally	This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.returnShipmentInfo .allShipmentTrackings .deliveryDate	DateTime	Conditionally	This field has been replaced by actualDeliveryDate.
detail.returnShipmentInfo .allShipmentTrackings .deliveryDate.formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings .deliveryDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .allShipmentTrackings .deliveryStatus	token	Conditionally	This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded. Applicable values: See TrackingStatusEnum
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped to.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.address	Address	Conditionally	This container holds the address of the named party.
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.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .allShipmentTrackings .destinationAddress.name	string	Conditionally	The identity of the party associated with this address.
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.returnShipmentInfo .allShipmentTrackings .labelAvailableUntilDate	string	Conditionally	This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.returnShipmentInfo .allShipmentTrackings .labelDate	DateTime	Conditionally	This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.returnShipmentInfo .allShipmentTrackings .labelDate.formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings .labelDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.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.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.returnShipmentInfo .allShipmentTrackings .markAsReceived	boolean	Conditionally	This Boolean will be returned as `true` if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.returnShipmentInfo .allShipmentTrackings .maxDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.returnShipmentInfo .allShipmentTrackings .maxDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings .maxDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .allShipmentTrackings .minDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.returnShipmentInfo .allShipmentTrackings .minDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings .minDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .allShipmentTrackings .originAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped from.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.address	Address	Conditionally	This container holds the address of the named party.
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.returnShipmentInfo .allShipmentTrackings .originAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.returnShipmentInfo .allShipmentTrackings .originAddress.address.country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.address.county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.returnShipmentInfo .allShipmentTrackings .originAddress.address.script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.returnShipmentInfo .allShipmentTrackings .originAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .allShipmentTrackings .originAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.returnShipmentInfo .allShipmentTrackings.shipDate	DateTime	Conditionally	This field has been replaced by the actualShipDate field.
detail.returnShipmentInfo .allShipmentTrackings.shipDate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .allShipmentTrackings.shipDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.returnShipmentInfo .allShipmentTrackings .shippedBy	token	Conditionally	Indicates the party shipping the item, such as buyer or seller. Applicable values: See ReturnUserRoleEnum
detail.returnShipmentInfo .allShipmentTrackings .shippingMethod	token	Conditionally	This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own. Applicable values: See ShippingMethodEnum
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.returnShipmentInfo .payee	token	Conditionally	Indicates the party whom is paying for shipping the item, such as buyer or seller. Applicable values: See ReturnUserRoleEnum
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.returnShipmentInfo .shipmentTracking.active	boolean	Conditionally	This Boolean indicates whether or not a return request is still in an active state.
detail.returnShipmentInfo .shipmentTracking .actualDeliveryDate	DateTime	Conditionally	This timestamp indicates the date/time when the shipment arrived at its destination address. This field will not be returned until the deliveryStatus value is returned as `DELIVERED`.
detail.returnShipmentInfo .shipmentTracking .actualDeliveryDate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking .actualDeliveryDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .shipmentTracking .actualShipDate	DateTime	Conditionally	This timestamp indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been marked as shipped.
detail.returnShipmentInfo .shipmentTracking .actualShipDate.formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking .actualShipDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .shipmentTracking.carrierEnum	token	Conditionally	Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values. Applicable values: See ShippingCarrierEnum
detail.returnShipmentInfo .shipmentTracking.carrierId	integer	Conditionally	This integer value is the numeric identifier of the shipping carrier. This field is returned if available.
detail.returnShipmentInfo .shipmentTracking.carrierName	string	Conditionally	This field is used to show the name of the shipping carrier. This field is returned if available.
detail.returnShipmentInfo .shipmentTracking.carrierUsed	string	Conditionally	This string value indicates the shipping carrier used to ship the item. This field is returned if available.
detail.returnShipmentInfo .shipmentTracking.deliveryDate	DateTime	Conditionally	This field has been replaced by actualDeliveryDate.
detail.returnShipmentInfo .shipmentTracking.deliveryDate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking.deliveryDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .shipmentTracking .deliveryStatus	token	Conditionally	This enumerated value indicates whether the item was delivered or is still in-transit. This field is returned if shipment tracking has been uploaded. Applicable values: See TrackingStatusEnum
detail.returnShipmentInfo .shipmentTracking .destinationAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped to.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.address	Address	Conditionally	This container holds the address of the named party.
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.returnShipmentInfo .shipmentTracking .destinationAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.returnShipmentInfo .shipmentTracking .destinationAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.returnShipmentInfo .shipmentTracking .destinationAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.returnShipmentInfo .shipmentTracking .destinationAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shipmentTracking .destinationAddress.name	string	Conditionally	The identity of the party associated with this address.
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.returnShipmentInfo .shipmentTracking .labelAvailableUntilDate	string	Conditionally	This timestamp indicates when the shipping label will expire and will no longer be valid to print and use.
detail.returnShipmentInfo .shipmentTracking.labelDate	DateTime	Conditionally	This timestamp indicates when the shipping label was created. This container is return if a shipping label exists for the order line item.
detail.returnShipmentInfo .shipmentTracking.labelDate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking.labelDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.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.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.returnShipmentInfo .shipmentTracking .markAsReceived	boolean	Conditionally	This Boolean will be returned as `true` if the item has been received by the recipient, and it is up to the recipient to mark the item as received.
detail.returnShipmentInfo .shipmentTracking .maxDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.returnShipmentInfo .shipmentTracking .maxDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking .maxDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .shipmentTracking .minDeliveryEstimate	DateTime	Conditionally	This timestamp indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.
detail.returnShipmentInfo .shipmentTracking .minDeliveryEstimate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking .minDeliveryEstimate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
detail.returnShipmentInfo .shipmentTracking .originAddress	ReturnAddressType	Conditionally	This container provides the full address where the item is being shipped from.
detail.returnShipmentInfo .shipmentTracking .originAddress.address	Address	Conditionally	This container holds the address of the named party.
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.returnShipmentInfo .shipmentTracking .originAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.returnShipmentInfo .shipmentTracking .originAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
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.returnShipmentInfo .shipmentTracking .originAddress.address.country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shipmentTracking .originAddress.address.county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.returnShipmentInfo .shipmentTracking .originAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.returnShipmentInfo .shipmentTracking .originAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.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.returnShipmentInfo .shipmentTracking .originAddress.address.script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.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.returnShipmentInfo .shipmentTracking .originAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shipmentTracking .originAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shipmentTracking .originAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.returnShipmentInfo .shipmentTracking.shipDate	DateTime	Conditionally	This field has been replaced by the actualShipDate field.
detail.returnShipmentInfo .shipmentTracking.shipDate .formattedValue	string	Conditionally	Reserved for future use.
detail.returnShipmentInfo .shipmentTracking.shipDate .value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
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.returnShipmentInfo .shipmentTracking.shippedBy	token	Conditionally	Indicates the party shipping the item, such as buyer or seller. Applicable values: See ReturnUserRoleEnum
detail.returnShipmentInfo .shipmentTracking .shippingMethod	token	Conditionally	This enumerated value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own. Applicable values: See ShippingMethodEnum
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.returnShipmentInfo .shippingLabelCost	ReturnShippingCostDetailType	Conditionally	This container provide the itemized list of shipping costs and how much it costs to purchase the shipping label to ship an item.
detail.returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost	array of ItemizedReturnShippingCostType	Conditionally	This container consists of the shipping cost to return ship an item. An itemizedReturnShippingCost container is required for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service.
detail.returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .amount	Amount	Conditionally	This dollar value indicates the amount for the shipping cost type shown in the returnShippingCostType field.
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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.returnShipmentInfo .shippingLabelCost .itemizedReturnShippingCost .returnShippingCostType	string	Conditionally	This enumerated value indicates the type of shipping cost, such as the cost of the shipping label, shipping insurance, or the signature confirmation service. Applicable values are from ReturnShippingCostType: INSURANCE Indicates the shipping cost is the price of shipping insurance if it used to return ship the item back to the seller. LABEL_COST Indicates the shipping cost is the price of the shipping label to return the item to the seller. OTHER Indicates the shipping cost is not classified or is not known. SIGNATURE_CONFIRMATION_COST Indicates the shipping cost is the price to return ship the item to the seller using certified shipping. Code so that your app gracefully handles any future changes to this list.
detail.returnShipmentInfo .shippingLabelCost.totalAmount	Amount	Conditionally	This value is the total amount of shipping costs associated with return shipping the item. This value should equal the sum of the values in the itemizedReturnShippingCost.amount field(s).
detail.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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
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.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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
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.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.RMANumber	string	Conditionally	This field shows the return merchandise authorization (RMA) for the return. This field is only returned if an RMA is associated with the return request.
detail.sellerAddress	ReturnAddressType	Conditionally	This container provides the seller's default shipping address.
detail.sellerAddress.address	Address	Conditionally	This container holds the address of the named party.
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.sellerAddress.address .addressLine2	string	Conditionally	The second line of the street address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
detail.sellerAddress.address .addressType	string	Conditionally	This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type. Applicable values are from AddressTypeEnum:See addressType. Code so that your app gracefully handles any future changes to this list.
detail.sellerAddress.address .city	string	Conditionally	The city of the address. This field is always used by containers using the Address type.
detail.sellerAddress.address .country	string	Conditionally	This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type. Applicable values are from CountryCodeEnum:See country. Code so that your app gracefully handles any future changes to this list.
detail.sellerAddress.address .county	string	Conditionally	The county of the address. This field is not always used, but it should be provided in the POST /post-order/v2/casemanagement/{caseId}/provide_return_address call if applicable.
detail.sellerAddress.address .isTransliterated	boolean	Conditionally	This Boolean field is returned as 'true' if language transliteration was required.
detail.sellerAddress.address .nationalRegion	string	Conditionally	This string value indicates a specific region or metropolitan area within a county in which the address resides. Not all countries have defined national regions.
detail.sellerAddress.address .postalCode	string	Conditionally	The postal code of the address. This field is always used by containers using the Address type.
detail.sellerAddress.address .script	string	Conditionally	This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See script. Code so that your app gracefully handles any future changes to this list.
detail.sellerAddress.address .stateOrProvince	string	Conditionally	The state or province of the address. This field is always used by containers using the Address type.
detail.sellerAddress.address .transliteratedFromScript	string	Conditionally	This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic. Applicable values are from LanguageScriptEnum:See transliteratedFromScript. Code so that your app gracefully handles any future changes to this list.
detail.sellerAddress.address .worldRegion	string	Conditionally	This string value indicates the region of the world in which the address resides. Values you'll see in this field include 'NORTH_AMERICA', 'EUROPEAN_UNION', or 'AUSTRALIA'. This field is not always used by containers using the Address type. Applicable values are from WorldRegionEnum:See worldRegion. Code so that your app gracefully handles any future changes to this list.
detail.sellerAddress.name	string	Conditionally	The identity of the party associated with this address.
detail.sellerLoginName	string	Conditionally	This string value is the eBay user name of the seller.
summary	ReturnSummaryType	Conditionally	This container consists of summarized information on the order line item that is associated with the return request. This container is not returned if the fieldgroups query parameter is omitted, or if it is used and its value is set to `FULL` or `NONE`.'
summary.buyerAvailableOptions	array of AvailableOptionType	Conditionally	This container consists of the next option(s) that are available to the buyer to move the return request to the next stage. A buyerAvailableOptions container will be returned for each option that is available to the buyer.
summary.buyerAvailableOptions .actionType	token	Always	This token value informs the buyer or seller what the next action is to move the return request to the next stage. Note that not all values in the ActivityOptionEnum type are applicable and possibly returned in this field. Applicable values: See ActivityOptionEnum
summary.buyerAvailableOptions .actionURL	string	Conditionally	This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action.
summary.buyerLoginName	string	Conditionally	This string value is the eBay user name of the buyer.
summary.buyerResponseDue	ReturnResponseDueType	Conditionally	This container indicates when the next buyer response on the return is due.
summary.buyerResponseDue .activityDue	token	Conditionally	This value informs the buyer or seller what the next action is to move the return request to the next stage. Applicable values: See ActivityOptionEnum
summary.buyerResponseDue .respondByDate	DateTime	Conditionally	This timestamp indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.
summary.buyerResponseDue .respondByDate.formattedValue	string	Conditionally	Reserved for future use.
summary.buyerResponseDue .respondByDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
summary.buyerTotalRefund	TotalRefundAmountType	Conditionally	This container returns the total refund amount for the buyer. The call returns either the estimated (pre-refund) amount due or the actual (post-refund) amount paid. In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from sources other than the seller. This can happen, for example, when eBay collects and remits state sales taxes for the items being refunded.
summary.buyerTotalRefund .actualRefundAmount	Amount	Conditionally	This container is returned after a refund has been issued and shows the actual refund amount paid 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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund .actualRefundAmount .convertedFromValue	number	Conditionally	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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund .actualRefundAmount .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	Returned before a refund has been issued, this container shows the estimated refund amount due 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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund .estimatedRefundAmount .convertedFromValue	number	Conditionally	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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
summary.buyerTotalRefund .estimatedRefundAmount .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, the reason for the return, and the buyer's preference to either get money back for item or to get a replacement item from the seller.
summary.creationInfo.comments	Text	Conditionally	If provided by the buyer at return creation time, this container provides more information to the seller about why a return is being requested. This container is only returned if the buyer made a comment at the time of creating the return request or draft.
summary.creationInfo.comments .content	string	Conditionally	This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
summary.creationInfo.comments .language	string	Conditionally	This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type. Applicable values are from LanguageEnum:See language. Code so that your app gracefully handles any future changes to this list.
summary.creationInfo.comments .translatedFromContent	string	Conditionally	If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
summary.creationInfo.comments .translatedFromLanguage	string	Conditionally	If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable. Applicable values are from LanguageEnum:See translatedFromLanguage. Code so that your app gracefully handles any future changes to this list.
summary.creationInfo .creationDate	DateTime	Always	This timestamp indicates the date/time when the return request was created.
summary.creationInfo .creationDate.formattedValue	string	Conditionally	Reserved for future use.
summary.creationInfo .creationDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-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	token	Always	This enumerated value indicates the buyer's reason for creating a return request or draft. Applicable values: See ReturnReasonEnum
summary.creationInfo .reasonType	token	Conditionally	This value indicates the reason the buyer is opening the return request. Applicable values: See ReturnReasonTypeEnum
summary.creationInfo.type	token	Always	This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item). Applicable values: See ReturnTypeEnum
summary.currentType	token	Conditionally	This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item). Applicable values: See ReturnTypeEnum
summary.escalationInfo	EscalationInfoType	Conditionally	This container provides information on whether or not the buyer or seller is eligible to escalate a return request to a case, and if a return request was escalated, a caseId can be found in this container.
summary.escalationInfo .buyerEscalationEligibilityInfo	EscalationEligibilityInfo	Always	This container indicates if the buyer is eligible to escalate the return request into a return case. If the buyer is eligible to escalate the return request into a return case, the time window during which this buyer must perform this action is returned under this container.
summary.escalationInfo .buyerEscalationEligibilityInfo .eligible	boolean	Always	This Boolean value indicates whether or not the buyer or seller is eligible to escalate the case. If the value is 'true', the time window in which the buyer or seller can escalate the case is found in the startTime and endTime fields.
summary.escalationInfo .buyerEscalationEligibilityInfo .endTime	DateTime	Conditionally	This timestamp provides the deadline in which the buyer or seller may escalate the case. As soon as this time expires, the buyer or seller may no longer escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo .buyerEscalationEligibilityInfo .endTime.formattedValue	string	Conditionally	Reserved for future use.
summary.escalationInfo .buyerEscalationEligibilityInfo .endTime.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
summary.escalationInfo .buyerEscalationEligibilityInfo .startTime	DateTime	Conditionally	This timestamp provides the earliest date in which the buyer or seller may escalate the case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo .buyerEscalationEligibilityInfo .startTime.formattedValue	string	Conditionally	Reserved for future use.
summary.escalationInfo .buyerEscalationEligibilityInfo .startTime.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-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 case. If the value is 'true', the time window in which the buyer or seller can escalate the case is found in the startTime and endTime fields.
summary.escalationInfo .sellerEscalationEligibilityInfo .endTime	DateTime	Conditionally	This timestamp provides the deadline in which the buyer or seller may escalate the case. As soon as this time expires, the buyer or seller may no longer escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo .sellerEscalationEligibilityInfo .endTime.formattedValue	string	Conditionally	Reserved for future use.
summary.escalationInfo .sellerEscalationEligibilityInfo .endTime.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
summary.escalationInfo .sellerEscalationEligibilityInfo .startTime	DateTime	Conditionally	This timestamp provides the earliest date in which the buyer or seller may escalate the case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the case. This field will not be returned if the value of the eligible field is 'false'.
summary.escalationInfo .sellerEscalationEligibilityInfo .startTime.formattedValue	string	Conditionally	Reserved for future use.
summary.escalationInfo .sellerEscalationEligibilityInfo .startTime.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-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 call to provide the buyer with the RMA number.
summary.returnPolicy .rmaRequired	boolean	Conditionally	This Boolean field is returned as `true` if the seller is expected to provide a return merchandise authorization (RMA) number to the buyer before the buyer return ships the order line item. The seller can use the POST /post-order/v2/return/{returnId}/decide call to provide the buyer with the RMA number for the item.
summary.sellerAvailableOptions	array of AvailableOptionType	Conditionally	This container consists of the next option(s) that are available to the seller to move the return request to the next stage. A sellerAvailableOptions container will be returned for each option that is available to the seller.
summary.sellerAvailableOptions .actionType	token	Always	This token value informs the buyer or seller what the next action is to move the return request to the next stage. Note that not all values in the ActivityOptionEnum type are applicable and possibly returned in this field. Applicable values: See ActivityOptionEnum
summary.sellerAvailableOptions .actionURL	string	Conditionally	This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action.
summary.sellerLoginName	string	Conditionally	This string value is the eBay user name of the seller.
summary.sellerResponseDue	ReturnResponseDueType	Conditionally	This container indicates when the next seller response on the return is due.
summary.sellerResponseDue .activityDue	token	Conditionally	This value informs the buyer or seller what the next action is to move the return request to the next stage. Applicable values: See ActivityOptionEnum
summary.sellerResponseDue .respondByDate	DateTime	Conditionally	This timestamp indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.
summary.sellerResponseDue .respondByDate.formattedValue	string	Conditionally	Reserved for future use.
summary.sellerResponseDue .respondByDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`
summary.sellerTotalRefund	TotalRefundAmountType	Conditionally	This container returns the total refund amount from the seller to the buyer. The call returns either the estimated (pre-refund) amount due or the actual (post-refund) amount paid.
summary.sellerTotalRefund .actualRefundAmount	Amount	Conditionally	This container is returned after a refund has been issued and shows the actual refund amount paid 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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund .actualRefundAmount .convertedFromValue	number	Conditionally	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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund .actualRefundAmount .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	Returned before a refund has been issued, this container shows the estimated refund amount due 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. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund .estimatedRefundAmount .convertedFromValue	number	Conditionally	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. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
summary.sellerTotalRefund .estimatedRefundAmount .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	token	Conditionally	Indicates the current state of the return. Applicable values: See ReturnStateEnum
summary.status	token	Conditionally	Indicates the current status of the return request. Applicable values: See ReturnStatusEnum
summary.timeoutDate	DateTime	Conditionally	This timestamp indicates the date and time the seller's response for return request expires. At this time, the return request is the closed due to the seller's non-response.
summary.timeoutDate .formattedValue	string	Conditionally	Reserved for future use.
summary.timeoutDate.value	datetime	Conditionally	The date and time defining the start or end of an action or event. 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: `2020-08-20T00:00:00.000Z`

null

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.

Available samples:

Basic Call ↓ - Retrieve a specific return request
Refund for a returned item ↓ - Retrieve an Return case for a cross-border trade order.

Sample: Basic Call

Retrieve a specific return request

Description

This call retrieves a specifice return request. The amount of detail returned in the response is controlled by a query parameter.

Input

The seller is looking for a specific return requests, identified through the returnId path parameter as return request #5********2. The seller wants to see full details on this return request, so includes the fieldgroups query parameter and sets its value to FULL.

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

GET https://api.ebay.com/post-order/v2/return/5********2?
   fieldgroups=FULL

Output

The response shows that return request #5********2 is in the closed state, and the return request ended with a full PayPal refund to the buyer. All of the actions in the return request are shown in the responseHistory container. The details of the last action (the PayPal refund) is shown in the refundInfo.actualRefundDetail.actualRefund.itemizedRefundDetail container. The buyer was refunded for the purchase price and the original shipping cost.

JSON format.
{ 
"summary":
    { 
    "returnId": "5********2",
    "currentType": MONEY_BACK,
    "state": CLOSED,
    "buyerLoginName": "b********4",
    "sellerLoginName": "s*********5",
    "buyerTotalRefund":
        { 
        "actualRefundAmount":
            { 
            "value": 43.5,
            "currency": USD
            }
        },
    "creationInfo":
        { 
        "creationDate":
            { 
            "value": "2015-07-27T10:35:24.000Z"
            },
        "item":
            { 
            "itemId": "1**********7",
            "transactionId": "8********9",
            "returnQuantity": 1
            },
        "reason": ORDERED_ACCIDENTALLY,
        "type": MONEY_BACK
        },
    "sellerTotalRefund":
        { /* TotalRefundAmountType */
        "actualRefundAmount":
            { 
						"value": 43.5,
						"currency": USD
						}
        },
    },
"detail":
    { 
    "buyerLoginName": "b********4",
    "sellerLoginName": "s*********5",
    "itemDetail":
        { 
        "itemId": "1**********7",
				"transactionId": "8********9",
        "returnQuantity": 1
        },
    "marketplaceId": EBAY_US,
    "moneyMovementInfo": [
        { 
        "actualAmount":
            { 
            "value": 43.5,
						"currency": USD
            },
        "creationDate":
            { 
            "2015-08-02T20:18:17.000Z"
            },
        "moneyMovementType": PAYPAL_REFUND,
        "paymentProvider": PAYPAL,
        "requestedAmount":
            { 
            "value": 43.5,
						"currency": USD
            },
        "status": SUCCESS
        }
      ],
    "refundInfo":
        { 
        "actualRefundDetail":
            { 
            "actualRefund":
                { 
                "itemizedRefundDetail": [
                    { 
                    "refundAmount":
                        { 
                        "value": 40.0,
												"currency": USD
                        },
                    "refundFeeType": PURCHASE_PRICE,
                    },
                    { 
										"refundAmount":
												{ 
												"value": 3.5,
												"currency": USD
												},
										"refundFeeType": ORIGINAL_SHIPPING,
                    }
                  ],
                "totalAmount":
                    { 
                    "value": 43.5,
										"currency": USD
                    }
                },
            "refundInitiationType": SELLER_INITIATED,
            "refundIssuedDate":
                { 
            		"value": "2015-08-02T20:18:17.000Z"
                },
            "refundStatus": SUCCESS
            }
        },
    "responseHistory": [
        { 
        "author": BUYER,
        "activity": BUYER_CREATE_RETURN,
        "creationDate":
            { 
            "value": "2015-07-27T10:35:24.000Z"
            },
        "fromState": INITIAL,
        "toState": RETURN_REQUESTED
        },
        { 
				"author": SELLER,
				"activity": SELLER_APPROVE_REQUEST,
				"creationDate":
						{ 
						"value": "2015-07-27T11:13:54.000Z"
						},
				"fromState": RETURN_REQUESTED,
				"toState": RETURN_ACCEPTED
        },
 				{ 
				"author": BUYER,
				"activity": BUYER_MARK_RETURN_SHIPPED,
				"creationDate":
						{ 
						"value": "2015-07-28T08:30:23.000Z"
						},
				"fromState": RETURN_ACCEPTED,
				"toState": ITEM_SHIPPED
        },
        { 
				"author": SELLER,
				"activity": SELLER_MARK_AS_RECEIVED,
				"creationDate":
						{ 
						"value": "2015-07-31T12:23:09.000Z"
						},
				"fromState": ITEM_SHIPPED,
				"toState": ITEM_DELIVERED
        },
        { 
				"author": SELLER,
				"activity": SELLER_ISSUE_REFUND,
				"creationDate":
						{ 
						"value": "2015-07-31T13:18:46.000Z"
						},
				"fromState": ITEM_DELIVERED,
				"toState": REFUND_SENT_PENDING_CONFIRMATION
        },
        { 
				"author": BUYER,
				"activity": BUYER_MARK_REFUND_RECEIVED,
				"creationDate":
						{ 
						"value": "2015-07-31T15:20:12.000Z"
						},
				"fromState": REFUND_SENT_PENDING_CONFIRMATION,
				"toState": CLOSED
        }
      ]
    }
}

Back to list of samples

Sample: Refund for a returned item

Retrieve an Return case for a cross-border trade order.

Description

A seller wants to get the current status and full details of a Return request. In this particular case, this was a 'buyer remorse' refund, and the seller accepted the return and issued a full refund to the buyer.

Input

The seller passes in the Return ID as a path parameter. There is no request payload for this call. The seller wants to see full details on this return request, so includes the fieldgroups query parameter and sets its value to FULL.

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

GET https://api.ebay.com/post-order/v2/return/5********0?
   fieldgroups=FULL

Output

The response of the call indicates that the reason for the return was that the buyer no longer wanted the item (see the creationInfo.reason field). The specific line item is identified with the itemId and transactionId values.

The seller accepts the return request, the buyer ends up receiving the full refund, and the actualRefundDetail.fundings container indicates that the funds for the buyer refund is retrieved through a direct debit of the seller's bank account on file. The seller was a Canadian seller that listed the item on the eBay US marketplace, so the fundings.amount container shows the amount of the refund in Canadian dollars.

The actualRefundDetail.actualRefund.totalAmount container shows the total amount (58.67 in USD) of the refund, the actualRefundDetail.actualRefund.feeCreditAmount container shows the selling fee credits amount (3.58 in USD) due back to the seller, and the actualRefundDetail.netChargeAmount container shows the net amount (55.09 in USD) charged to the seller for recoupment of the buyer's refund. The 55.09 value is derived from subtracing the fee credit amount (3.58) from the total amount of the refund (58.67). The 55.09 net charge is converted into Canadian dollars (70.68), and the exchange rate used is also shown in the exchangeRate field.

The refund to the buyer and the selling (final value fee) credit to the seller are also captured in separate nodes under the moneyMovementInfo array.

JSON format.
{
    "summary": {
        "returnId": "5********0",
        "orderId": "2*-*****-****6",
        "buyerLoginName": "r*******************t",
        "sellerLoginName": "c**********2",
        "currentType": "MONEY_BACK",
        "state": "CLOSED",
        "status": "CLOSED",
        "creationInfo": {
            "item": {
                "itemId": "2**********0",
                "transactionId": "1********16",
                "returnQuantity": 1,
                "itemTitle": "Fixed Price Item - 1***********2"
            },
            "type": "MONEY_BACK",
            "reason": "NO_LONGER_NEED_ITEM",
            "reasonType": "REMORSE",
            "comments": {
                "content": "remorse"
            },
            "creationDate": {
                "value": "2020-08-14T23:06:12.000Z"
            }
        },
        "sellerTotalRefund": {
            "estimatedRefundAmount": {
                "value": 58.67,
                "currency": "USD"
            },
            "actualRefundAmount": {
                "value": 58.67,
                "currency": "USD"
            }
        },
        "buyerTotalRefund": {
            "estimatedRefundAmount": {
                "value": 64.1,
                "currency": "USD"
            },
            "actualRefundAmount": {
                "value": 64.1,
                "currency": "USD"
            }
        },
        "sellerResponseDue": {
            "activityDue": "SELLER_ISSUE_REFUND",
            "respondByDate": {
                "value": "2020-08-19T06:59:59.000Z"
            }
        },
        "buyerResponseDue": {
            "activityDue": "BUYER_ESCALATE",
            "respondByDate": {
                "value": "2020-09-05T06:59:59.000Z"
            }
        },
        "escalationInfo": {
            "buyerEscalationEligibilityInfo": {
                "startTime": null,
                "endTime": null,
                "eligible": false
            },
            "sellerEscalationEligibilityInfo": {
                "startTime": null,
                "endTime": null,
                "eligible": false
            }
        },
        "sellerAvailableOptions": [
            {
                "actionType": "OTHER",
                "actionURL": "https://www.qa.ebay.com/rtn/Return/ReturnsDetail?returnId=5********0"
            }
        ],
        "buyerAvailableOptions": [
            {
                "actionType": "BUYER_PRINT_SHIPPING_LABEL",
                "actionURL": "https://www.qa.ebay.com/rtn/Return/ReturnsDetail?returnId=5********0"
            },
            {
                "actionType": "EXTERNAL_CLAIM_OPENED",
                "actionURL": "https://www.qa.ebay.com/rtn/Return/ReturnsDetail?returnId=5********0"
            }
        ],
        "returnPolicy": {
            "rmarequired": false
        },
        "timeoutDate": {
            "value": "2020-09-19T06:59:59.999Z"
        }
    },
    "detail": {
        "marketplaceId": "EBAY_US",
        "itemDetail": {
            "itemId": "2**********0",
            "transactionId": "1********16",
            "listingSiteId": 0,
            "returnQuantity": 1,
            "ebayPlusTxn": false
        },
        "buyerLoginName": "r*******************t",
        "sellerLoginName": "c**********2",
        "responseHistory": [
            {
                "author": "BUYER",
                "activity": "BUYER_CREATE_RETURN",
                "fromState": "INITIAL",
                "toState": "RETURN_REQUESTED",
                "creationDate": {
                    "value": "2020-08-14T23:06:12.000Z"
                },
                "notes": "remorse",
                "attributes": {
                    "sellerReturnAddress": {
                        "name": "J*** D**",
                        "address": {
                            "addressLine1": "5*********t.",
                            "addressLine2": "",
                            "city": "Cambridge",
                            "stateOrProvince": "MA",
                            "postalCode": "0***9-****",
                            "country": "US"
                        }
                    }
                }
            },
            {
                "author": "SELLER",
                "activity": "SELLER_ISSUE_REFUND",
                "fromState": "RETURN_REQUESTED",
                "toState": "REFUND_INITIATED",
                "creationDate": {
                    "value": "2020-08-14T23:09:07.000Z"
                },
                "attributes": {}
            },
            {
                "author": "SYSTEM",
                "activity": "NOTIFY_UPDATE_REFUND_STATUS",
                "fromState": "REFUND_INITIATED",
                "toState": "CLOSED",
                "creationDate": {
                    "value": "2020-08-14T23:17:10.000Z"
                },
                "attributes": {}
            }
        ],
        "refundInfo": {
            "estimatedRefundDetail": {
                "itemizedRefundDetails": [
                    {
                        "refundFeeType": "PURCHASE_PRICE",
                        "estimatedAmount": {
                            "value": 58.67,
                            "currency": "USD"
                        },
                        "overwritableBySeller": false,
                        "amountEditable": false
                    }
                ]
            },
            "actualRefundDetail": {
                "actualRefund": {
                    "totalAmount": {
                        "value": 58.67,
                        "currency": "USD"
                    },
                    "itemizedRefundDetail": [
                        {
                            "refundFeeType": "PURCHASE_PRICE",
                            "refundAmount": {
                                "value": 58.67,
                                "currency": "USD"
                            }
                        }
                    ],
                    "feeCreditAmount": {
                        "value": 3.58,
                        "currency": "USD"
                    }
                },
                "refundStatus": "SUCCESS",
                "refundIssuedDate": {
                    "value": "2020-08-14T23:09:03.000Z"
                },
                "outstandingAmount": {
                    "value": 0.0,
                    "currency": "CAD"
                },
                "fundings": [
                    {
                        "date": {
                            "value": "2020-08-14T23:09:03.416Z"
                        },
                        "amount": {
                            "value": 70.68,
                            "currency": "CAD"
                        },
                        "fundingSource": {
                            "type": "DIRECT_DEBIT",
                            "memo": "P**************************************2"
                        },
                        "fundingStatus": "FUNDED"
                    }
                ],
                "netChargeAmount": {
                    "value": 70.68,
                    "convertedFromValue": 55.09,
                    "convertedFromCurrency": "USD",
                    "currency": "CAD",
                    "exchangeRate": "1.28301"
                }
            }
        },
        "moneyMovementInfo": [
            {
                "moneyMovementType": "REFUND_PROMOTED_LISTING_FEE",
                "status": "FAILED",
                "requestedAmount": {
                    "value": 0.0,
                    "currency": "USD"
                },
                "actualAmount": {
                    "value": 0.0
                },
                "creationDate": {
                    "value": "2020-08-14T23:17:27.000Z"
                },
                "paymentProvider": "UNKNOWN"
            },
            {
                "moneyMovementType": "REFUND_FINAL_VALUE_FEE_P20",
                "status": "SUCCESS",
                "requestedAmount": {
                    "value": 3.58,
                    "currency": "USD"
                },
                "actualAmount": {
                    "value": 3.58,
                    "currency": "USD"
                },
                "creationDate": {
                    "value": "2020-08-14T23:09:07.000Z"
                },
                "paymentProvider": "UNKNOWN"
            },
            {
                "moneyMovementType": "SELLER_VOLUNTARY_REFUND",
                "status": "SUCCESS",
                "requestedAmount": {
                    "value": 64.1,
                    "currency": "USD"
                },
                "actualAmount": {
                    "value": 64.1,
                    "currency": "USD"
                },
                "creationDate": {
                    "value": "2020-08-14T23:09:03.000Z"
                },
                "paymentProvider": "UNKNOWN"
            }
        ],
        "buyerAddress": {
            "name": "qibus buyer",
            "address": {
                "addressLine1": "2***************e.",
                "city": "San Jose",
                "stateOrProvince": "CA",
                "postalCode": "9***5",
                "country": "US"
            }
        },
        "sellerAddress": {
            "name": "J*** D**",
            "address": {
                "addressLine1": "5*********t.",
                "city": "Cambridge",
                "stateOrProvince": "MA",
                "postalCode": "0***9-****",
                "country": "US"
            }
        },
        "returnShipmentInfo": {
            "shipmentTracking": {
                "shippingMethod": "SHIPPING_LABEL",
                "shippedBy": "BUYER",
                "carrierId": 2,
                "carrierEnum": "USPS",
                "carrierName": "USPS",
                "carrierUsed": "USPS",
                "deliveryStatus": "UNKNOWN",
                "destinationAddress": {
                    "name": "J*** D**",
                    "address": {
                        "addressLine1": "5*********t.",
                        "city": "Cambridge",
                        "stateOrProvince": "MA",
                        "postalCode": "0***9-4**9",
                        "country": "US"
                    }
                },
                "originAddress": {
                    "name": "q**** b****",
                    "address": {
                        "addressLine1": "2***************e.",
                        "city": "San Jose",
                        "stateOrProvince": "CA",
                        "postalCode": "9***5",
                        "country": "US"
                    }
                },
                "markAsReceived": false,
                "active": true,
                "labelPrintExpired": false,
                "labelVoidExpired": false
            },
            "shippingLabelCost": {
                "totalAmount": {
                    "value": 5.93,
                    "currency": "USD"
                },
                "itemizedReturnShippingCost": [
                    {
                        "returnShippingCostType": "LABEL_COST",
                        "amount": {
                            "value": 5.93,
                            "currency": "USD"
                        }
                    }
                ]
            },
            "payee": "BUYER",
            "allShipmentTrackings": [
                {
                    "shippingMethod": "SHIPPING_LABEL",
                    "shippedBy": "BUYER",
                    "carrierId": 2,
                    "carrierEnum": "USPS",
                    "carrierName": "USPS",
                    "carrierUsed": "USPS",
                    "deliveryStatus": "UNKNOWN",
                    "destinationAddress": {
                        "name": "J*** D**",
                        "address": {
                            "addressLine1": "5*********t.",
                            "city": "Cambridge",
                            "stateOrProvince": "MA",
                            "postalCode": "0***9-****",
                            "country": "US"
                        }
                    },
                    "originAddress": {
                        "name": "q**** b****",
                        "address": {
                            "addressLine1": "2***************e.",
                            "city": "San Jose",
                            "stateOrProvince": "CA",
                            "postalCode": "9***5",
                            "country": "US"
                        }
                    },
                    "markAsReceived": false,
                    "active": true,
                    "labelPrintExpired": false,
                    "labelVoidExpired": false,
                    "multipleCarrierAvailable": false
                }
            ]
        },
        "closeInfo": {
            "returnCloseReason": "FULL_REFUNDED",
            "buyerCloseReason": "UNKNOWN",
            "returnCloseDate": {
                "value": "2020-08-14T23:17:10.000Z"
            }
        }
    }
}

Back to list of samples

Change History

Change Date	Description