eBay Post-Order APIVersion 2.7.2
 

Get Case

GET /post-order/v2/casemanagement/{caseId}

This method can be used on behalf of buyers and sellers to retrieve detailed information on a case, including case history and (if applicable) refund information, appeal information, and shipment tracking information.

The case is identified by the caseId value that is passed in as part of the call URI. You must be involved in the case in order to retrieve the case details.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/casemanagement/{caseId}

URI parameters

Parameter Type Required? Meaning
caseId string Required The unique identifier of a case. This URI parameter is required in order to identify the case to retrieve. The case ID value is passed in as part of the call URI. The buyer or seller must be involved in the case in order to retrieve details on the specified case.


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

See also Samples.

Payload model

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

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

{ /* CaseDetailsResponse */
"actionDeadlines":
    { /* ActionDeadlines */
    "daysForBuyerToProvideProofOfShipment": integer,
    "daysToExpireWithoutResponse": integer,
    "daysToExpireWithResponse": integer,
    "daysToReturnItem": integer,
    "maxDaysToFileClaim": integer
    },
"appealDetails":
    { /* AppealDetails */
    "appealCloseReasonEnum": string,
    "appealDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "appealReasonCode": string,
    "appealRefundAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "exchangeRate": string,
        "value": number
        },
    "appealStatus": string,
    "appealStatusEnum": string,
    "eligibleForAppeal": boolean
    },
"buyerClosureReason": string,
"buyerProtectedProgramLink": string,
"caseDetails":
    { /* CaseDetails */
    "buyerFinalAcceptResolution": string,
    "buyerInitExpectResolution": string,
    "creationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "escalationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "expirationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "lastBuyerRespDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "lastSellerRespDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "paypalPaid": boolean,
    "refundAmounts":
        { /* RefundAmounts */
        "buyerFinalAcceptRefundAmt":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "buyerInitExpectRefundAmt":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "feeCreditAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "internationalRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            },
        "refundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "exchangeRate": string,
            "value": number
            }
        },
    "refundChargeAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "exchangeRate": string,
        "value": number
        },
    "refundDeadlineDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "refundType": string
    },
"caseHistoryDetails":
    { /* ClaimHistoryResponse */
    "history": [
        { /* ClaimHistoryEventModel */
        "action": string,
        "actor": string,
        "date":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "description": string,
        "moneyMovement":
            { /* MoneyMovementEntries */
            "moneyMovementEntryList": [
                { /* MoneyMovementEntry */
                "amount":
                    { /* Amount */
                    "convertedFromCurrency": string,
                    "convertedFromValue": number,
                    "currency": string,
                    "exchangeRate": string,
                    "value": number
                    },
                "date":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "fundingSource":
                    { /* FundingSource */
                    "brand": string,
                    "memo": string,
                    "type": string
                    },
                "fundingStatus": string,
                "type": string
                }
                /* More MoneyMovementEntry nodes here */
              ]
            }
        }
        /* More ClaimHistoryEventModel nodes here */
      ],
    "shipmentTrackingDetails":
        { /* ShipmentTrackingDetailType */
        "carrier": string,
        "currentStatus": string,
        "estimateFromDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "estimateToDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "trackingNumber": string,
        "trackingURL": string
        }
    },
"caseId": string,
"caseQuantity": integer,
"caseType": string,
"claimAmount":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "exchangeRate": string,
    "value": number
    },
"creationDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"escalatedBy": string,
"escalateReason": string,
"eventTicketsLink": string,
"extTransactionId": string,
"fsnadDaysToAddTrackingAfterShippingItem": integer,
"fsnadShipToSellerByDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"initiator": string,
"itemId": string,
"lastModifiedDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"payForItemLink": string,
"priceSignatureConfirmationAmount": string,
"recalledItemLink": string,
"returnDetails":
    { /* ReturnAddress */
    "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
        },
    "editable": boolean,
    "firstName": string,
    "lastName": string,
    "RMA": string
    },
"returnId": string,
"sellerClosureReason": string,
"shippingFee":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "exchangeRate": string,
    "value": number
    },
"status": string,
"transactionId": string
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
actionDeadlines ActionDeadlines Conditionally This container provides the number of remaining days that a buyer or seller has before being required to take action on an INR or Return case.
actionDeadlines
  .daysForBuyerToProvideProofOfShipment
integer Always This integer value indicates the number of days that the buyer has to provide proof of return shipment before the case expires. This field is only returned for a Return case.
actionDeadlines
  .daysToExpireWithoutResponse
integer Always This integer value indicates the number of days that a user (buyer or seller) has to make a required response on the case before the case expires.
actionDeadlines
  .daysToExpireWithResponse
integer Always This integer value indicates the number of days that remain before the case expires.
actionDeadlines
  .daysToReturnItem
integer Conditionally This integer value indicates the number of remaining days that the buyer has to return an item and still expect a refund from the seller. This field is only returned for a Return case.
actionDeadlines
  .maxDaysToFileClaim
integer Conditionally This integer value indicates the number of remaining days that the buyer has to file a claim.
appealDetails AppealDetails Conditionally This container consists of information related to the appeal of a case decision. This container is only returned if the case decision was appealed by the buyer or seller.
appealDetails
  .appealCloseReasonEnum
string Conditionally This enumeration value indicates why the appeal on the case decision was closed. This field will only be returned if an appeal was made on a case decision and this appeal has been closed.

The list of enumeration values that may be returned in this field are defined in the AppealCloseReasonEnum type definition.

Applicable values: See AppealCloseReasonEnum
appealDetails.appealDate DateTime Conditionally The timestamp in this container indicates the date and time when the appeal was initiated by buyer or seller. This field will only be returned if an appeal was made on the case decision.
appealDetails.appealDate
  .formattedValue
string Conditionally Reserved for future use.
appealDetails.appealDate.value datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
appealDetails.appealReasonCode string Conditionally This string value is a string representation of why the buyer or seller appealed the case decision. This field is only returned if the buyer or seller made an appeal on the case decision.
appealDetails
  .appealRefundAmount
Amount Conditionally This container shows the total amount refunded to the seller if the seller wins an appeal on a case decision going against the seller. The value will be in the seller's default currency. This field is only returned if the seller made an appeal on the case decision.
appealDetails
  .appealRefundAmount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
appealDetails
  .appealRefundAmount
  .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.
appealDetails
  .appealRefundAmount.currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
appealDetails
  .appealRefundAmount
  .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.
appealDetails
  .appealRefundAmount.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.
appealDetails.appealStatus string Conditionally This enumeration value indicates whether or not eBay has accepted the buyer's or seller's appeal on the case decision. This field is only returned if the buyer or seller has attempted to make an appeal on the case decision.

Applicable values are from AppealGrantStatusEnum:

DENIED
This enumeration value indicates that the buyer's or seller's appeal was denied.
GRANTED
This enumeration value indicates that the buyer's or seller's appeal was granted.
OTHER
This enumeration value indicates that the outcome of the buyer's or seller's appeal is unknown.

Code so that your app gracefully handles any future changes to this list.
appealDetails.appealStatusEnum string Conditionally This enumeration value indicates the current status of the appeal against the case decision.

The list of enumeration values that may be returned in this field are defined in the AppealStatusEnum type definition.

Applicable values: See AppealStatusEnum
appealDetails
  .eligibleForAppeal
boolean Conditionally This boolean field will be returned as true if the buyer or seller is eligible to appeal the decision on the case.
buyerClosureReason string Conditionally This enumeration value indicates why the buyer chose to close the case. This field is only returned if the buyer closed the case, or if the case was closed on behalf of the buyer.

The list of enumeration values that may be returned in this field are defined in the CaseCloseReasonEnum type definition.

Applicable values: See CaseCloseReasonEnum
buyerProtectedProgramLink string Conditionally This string value is the URL for the eBay Resolution Center.
caseDetails CaseDetails Always This container provides detailed information about the case.
caseDetails
  .buyerFinalAcceptResolution
string Conditionally This string value indicates what the buyer ultimately agreed to with the seller to resolve the case.
caseDetails
  .buyerInitExpectResolution
string Conditionally This string value indicates what the buyer initially agreed to with the seller to resolve the case.
caseDetails.creationDate DateTime Always The timestamp in this container indicates when the case was created.
caseDetails.creationDate
  .formattedValue
string Conditionally Reserved for future use.
caseDetails.creationDate.value datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseDetails.escalationDate DateTime Always The timestamp in this container indicates when the associated INR inquiry or return request was escalated into a case.
caseDetails.escalationDate
  .formattedValue
string Conditionally Reserved for future use.
caseDetails.escalationDate
  .value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseDetails.expirationDate DateTime Always The timestamp in this container indicates when a case will expire naturally if a required response from the buyer or seller is not made.
caseDetails.expirationDate
  .formattedValue
string Conditionally Reserved for future use.
caseDetails.expirationDate
  .value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseDetails.lastBuyerRespDate DateTime Conditionally The timestamp in this container indicates when the buyer last responded to, or performed an action on the case. This field is only returned if the buyer has responded to and/or performed an action on the case.
caseDetails.lastBuyerRespDate
  .formattedValue
string Conditionally Reserved for future use.
caseDetails.lastBuyerRespDate
  .value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseDetails.lastSellerRespDate DateTime Conditionally The timestamp in this container indicates when the seller last responded to, or performed an action on the case. This field is only returned if the seller has responded to and/or performed an action on the case.
caseDetails.lastSellerRespDate
  .formattedValue
string Conditionally Reserved for future use.
caseDetails.lastSellerRespDate
  .value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseDetails.paypalPaid boolean Conditionally THIS FIELD IS DEPRECATED.
caseDetails.refundAmounts RefundAmounts Conditionally This container consists of details related to the expected and actual refund amounts. This container is only returned if a refund is scheduled to, or has been issued to the buyer.
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
Amount Conditionally This container shows the refund amount finally accepted by the buyer.
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .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.
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .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.
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .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.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
Amount Conditionally This container shows the refund amount initially expected by the buyer.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .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.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .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.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .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.
caseDetails.refundAmounts
  .feeCreditAmount
Amount Conditionally This container shows the total amount of fees credited towards this refund as per eBay policy.
caseDetails.refundAmounts
  .feeCreditAmount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .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.
caseDetails.refundAmounts
  .feeCreditAmount.currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .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.
caseDetails.refundAmounts
  .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.
caseDetails.refundAmounts
  .internationalRefundAmount
Amount Conditionally This container shows the refund amount issued to the buyer for the international leg of a Global Shipping Program shipment. This container only applies for international orders where the seller used the Global Shipping Program to ship the order.
caseDetails.refundAmounts
  .internationalRefundAmount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .internationalRefundAmount
  .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.
caseDetails.refundAmounts
  .internationalRefundAmount
  .currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .internationalRefundAmount
  .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.
caseDetails.refundAmounts
  .internationalRefundAmount
  .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.
caseDetails.refundAmounts
  .refundAmount
Amount Conditionally This container shows the refund amount issued to the buyer.
caseDetails.refundAmounts
  .refundAmount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .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.
caseDetails.refundAmounts
  .refundAmount.currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundAmounts
  .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.
caseDetails.refundAmounts
  .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.
caseDetails.refundChargeAmount 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 and returned if a refund has been issued to the buyer.
caseDetails.refundChargeAmount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundChargeAmount
  .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.
caseDetails.refundChargeAmount
  .currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseDetails.refundChargeAmount
  .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.
caseDetails.refundChargeAmount
  .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.
caseDetails.refundDeadlineDate DateTime Conditionally The timestamp in this container indicates the latest date/time when the buyer is eligible for a refund.
caseDetails.refundDeadlineDate
  .formattedValue
string Conditionally Reserved for future use.
caseDetails.refundDeadlineDate
  .value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseDetails.refundType string Conditionally This enumeration value indicates whether the buyer is scheduled to, or has already received a a full or partial refund. This field is only returned if a refund is scheduled to, or has been issued to the buyer.

Applicable values are from RefundType:

FULL
This enumeration value indicates that the buyer is scheduled to, or has already received a full refund.
OTHER
This enumeration value indicates that it is unknown whether the buyer is scheduled to, or has already received a full or a partial refund.
PARTIAL
This enumeration value indicates that the buyer is scheduled to, or has already received a partial refund

Code so that your app gracefully handles any future changes to this list.
caseHistoryDetails ClaimHistoryResponse Always This container provides detailed information about the history of the case, including each action that has been performed on the case.
caseHistoryDetails.history array of ClaimHistoryEventModel Always This array contains one or more events or actions associated with an INR inquiry or a case.
caseHistoryDetails.history
  .action
string Always This string value indicates the action initiated by one of the parties involved with the INR inquiry or case.
caseHistoryDetails.history
  .actor
string Always This enumeration value indicates the party that took this action.

Applicable values are from UserPartyEnum:

BUYER
This enumeration value indicates that the initiator of the action is the buyer.
CSR
This enumeration value indicates that the initiator of the action is an eBay customer support representative.
SELLER
This enumeration value indicates that the initiator of the action is the seller.
SYSTEM
This enumeration value indicates that the initiator of the action is the eBay system.
UNKNOWN
This enumeration value indicates that the initiator of the action cannot be determined.

Code so that your app gracefully handles any future changes to this list.
caseHistoryDetails.history
  .date
DateTime Always The timestamp in this container indicates the date and time of this event or action.
caseHistoryDetails.history
  .date.formattedValue
string Conditionally Reserved for future use.
caseHistoryDetails.history
  .date.value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseHistoryDetails.history
  .description
string Conditionally A text-based description of this event or action. This field is returned if available.
caseHistoryDetails.history
  .moneyMovement
MoneyMovementEntries Conditionally This container provides details on one or more monetary transactions that were involved with the event or action. This container is not returned if no monetary transaction was involved with the event or action.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
array of MoneyMovementEntry Conditionally This array contains details about one or more monetary transactions associated with an INR inquiry or a case. This array is only returned if monetary transactions have occurred with the INR inquiry or case.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.amount
Amount Conditionally This container shows the amount of the monetary transaction.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.amount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.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.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.amount
  .currency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.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.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.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.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.date
DateTime Conditionally The timestamp in this container indicates the date/time of the monetary transaction.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.date
  .formattedValue
string Conditionally Reserved for future use.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.date
  .value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
  .fundingSource
FundingSource Conditionally This container provides details about the seller's funding source to issue a buyer refund, such as available seller payout funds, a bank account, or a credit card on file. This container is only applicable and returned if the monetary transaction is related to a buyer refund.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
  .fundingSource.brand
string Conditionally The enumeration value here indicates the brand of credit card used to fund the refund. This will be the seller's credit card on file with eBay.

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.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
  .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.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
  .fundingSource.type
string Conditionally he 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 through an invoice.

Code so that your app gracefully handles any future changes to this list.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
  .fundingStatus
string Conditionally This enumeration value indicates if eBay was able to successfully 'fund' a refund to the buyer using the seller's preferred method of payment for buyer refunds. This field is only applicable and returned if the monetary transaction is related to a buyer refund.

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 failed 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.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.type
string Conditionally This string value indicates the type of monetary transaction, such as a refund.
caseHistoryDetails
  .shipmentTrackingDetails
ShipmentTrackingDetailType Conditionally This container will show detailed shipment tracking information if an INR item is being shipped to the buyer, or if the buyer is returning an item to the seller. This container is only returned if shipment tracking is currently relevant to the inquiry or case.
caseHistoryDetails
  .shipmentTrackingDetails
  .carrier
string Conditionally The name of the shipping carrier handling the shipment. This field is generally always returned with the shipmentTrackingDetails container unless the tracking number has yet to be provided for the order line item.
caseHistoryDetails
  .shipmentTrackingDetails
  .currentStatus
string Conditionally The current status of the shipment, such as delivered or still in-transit. This field is returned if it is known and available.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateFromDate
DateTime Conditionally The date and time in this container is the earliest date that the shipment is estimated to be delivered, based on the shipping service being used, the stated handling time, and when the package was shipped. This container is returned if it is known and available.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateFromDate
  .formattedValue
string Conditionally Reserved for future use.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateFromDate.value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate
DateTime Conditionally The date and time in this container is the latest date that the shipment is estimated to be delivered, based on the shipping service being used, the stated handling time, and when the package was shipped. If the package is not received by this date, the buyer or seller should contact their order partner to get status, and then ask eBay to step in if the problem cannot be resolved. This container is returned if it is known and available.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate.formattedValue
string Conditionally Reserved for future use.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate.value
datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
caseHistoryDetails
  .shipmentTrackingDetails
  .trackingNumber
string Conditionally A unique identifier used to track the shipment of the order line item. This field is generally always returned with the shipmentTrackingDetails container unless the tracking number has yet to be provided for the order line item.
caseHistoryDetails
  .shipmentTrackingDetails
  .trackingURL
string Conditionally This field provides the URL to the shipping carrier's shipment tracking page. This field is returned if available.
caseId string Always The unique identifier of an INR or Return case.
caseQuantity integer Always This integer value indicates the quantity of the line item purchased by the buyer.
caseType string Always This enumeration type indicates if the case involves an item that has not been received by the buyer within the expected delivery window, or if the case involves a return request that has been escalated into a case by the buyer or seller after they were unable to come up with a return solution that would work for both parties.

Applicable values are from CaseTypeEnum:

ITEM_NOT_RECEIVED
This enumeration value indicates that the case was created by the buyer because the item wasn't received within the expected delivery window. INR inquiries can also be escalated to INR cases.
RETURN
This enumeration value indicates that the case was created after a return request was escalated by the buyer or seller.

Code so that your app gracefully handles any future changes to this list.
claimAmount Amount Always This container displays the dollar value of the case, which is generally the amount of the refund that the buyer will receive if the buyer wins the case, or if the seller voluntarily refunds the buyer.
claimAmount
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
claimAmount.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.
claimAmount.currency string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
claimAmount.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.
claimAmount.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.
creationDate DateTime Always The timestamp in this container indicates when the case was created.
creationDate.formattedValue string Conditionally Reserved for future use.
creationDate.value datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
escalatedBy string Always This enumeration value indicates the party that escalated the INR inquiry or return request into a case.

Applicable values are from UserPartyEnum:

BUYER
This enumeration value indicates that the initiator of the action is the buyer.
CSR
This enumeration value indicates that the initiator of the action is an eBay customer support representative.
SELLER
This enumeration value indicates that the initiator of the action is the seller.
SYSTEM
This enumeration value indicates that the initiator of the action is the eBay system.
UNKNOWN
This enumeration value indicates that the initiator of the action cannot be determined.

Code so that your app gracefully handles any future changes to this list.
escalateReason string Always Indicates why the buyer or seller escalated an INR inquiry or a return request into a case.

For an INR inquiry that was escalated, the applicable values are defined in the InquiryEscalationReasonEnum type definition. type.

For a return request that was escalated, the applicable values are defined in the EscalateReasonEnum type definition.

Applicable values: See InquiryEscalationReasonEnum
eventTicketsLink string Conditionally This string value is the URL for the event tickets page, where electronic event tickets can be downloaded by the purchaser. This field is only returned if the case involves an event tickets order.
extTransactionId string Conditionally This string value is the unique identifier of the payment transaction for the order. This field will only be returned if the payment transaction happened outside of eBay's system.
fsnadDaysToAddTrackingAfterShippingItem integer Conditionally This integer value indicates the number of days that the buyer has to provide shipment tracking information for an item that is being returned to the seller.

This field is only returned for Return cases, and only if the buyer is being required to provide shipment tracking information for the item being returned.
fsnadShipToSellerByDate DateTime Conditionally The timestamp in this container indicates the deadline when the buyer must ship the return item back to the seller. This container is only returned for Return cases, and only if the buyer has yet to ship the return item, or has not provided proof that the item has been shipped.
fsnadShipToSellerByDate
  .formattedValue
string Conditionally Reserved for future use.
fsnadShipToSellerByDate.value datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
initiator string Always This enumeration value indicates whether the buyer or the seller initiated the INR inquiry or Return request that has been escalated to a case. This value will usually be BUYER.

Applicable values are from UserPartyEnum:

BUYER
This enumeration value indicates that the initiator of the action is the buyer.
CSR
This enumeration value indicates that the initiator of the action is an eBay customer support representative.
SELLER
This enumeration value indicates that the initiator of the action is the seller.
SYSTEM
This enumeration value indicates that the initiator of the action is the eBay system.
UNKNOWN
This enumeration value indicates that the initiator of the action cannot be determined.

Code so that your app gracefully handles any future changes to this list.
itemId string Always The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the transactionId field to identify a line item that is associated with the case.
lastModifiedDate DateTime Always The timestamp in this container indicates when the last action was performed on the case.
lastModifiedDate
  .formattedValue
string Conditionally Reserved for future use.
lastModifiedDate.value datetime Conditionally This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
payForItemLink string Conditionally This string value is the URL for the purchase item page. This field will be returned if available/applicable.
priceSignatureConfirmationAmount string Conditionally This string value indicates the dollar value threshold for the signature confirmation add-on. The buyer must purchase the signature confirmation add-on for high-value items at or above this dollar value.
recalledItemLink string Conditionally This string is the URL for the recalled item page. This field will be returned if available/applicable.
returnDetails ReturnAddress Conditionally This container consists of information related to a buyer returning a line item to the seller, and includes the seller's return address and the RMA number (if applicable).

This container is only returned if the case type is a Return.
returnDetails.address Address Conditionally This container shows the full return address of the seller.
returnDetails.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.
returnDetails.address
  .addressLine2
string Conditionally The second line of the street address. This field is not always used, but it should be provided if applicable. It might be used for something like 'Suite Number' or 'Apt Number'.
returnDetails.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, PO Box, or other type of address. This field is not always used by containers using the Address type.

The list of enumeration values that may be returned in this field are defined in the AddressTypeEnum type definition.

Applicable values: See AddressTypeEnum
returnDetails.address.city string Conditionally The city of the address. This field is always used by containers using the Address type.
returnDetails.address.country string Conditionally This enumeration value indicates the country of the address. The three-letter country codes of the ISO 3166-1 Standard are used. This field is always used by containers using the Address type.

The list of two-digit country codes that may be returned in this field are defined in the CountryCodeEnum type definition.

Applicable values: See CountryCodeEnum
returnDetails.address.county string Conditionally The county of the address. This field is not always used, but it should be provided if applicable.
returnDetails.address
  .isTransliterated
boolean Conditionally This Boolean field is returned as true if language transliteration was required.
returnDetails.address
  .nationalRegion
string Conditionally This string value indicates a specific region or metropolitan area within a country in which the address resides. Not all countries have defined national regions.
returnDetails.address
  .postalCode
string Conditionally The postal code of the address. This field is always used by containers using the Address type.
returnDetails.address.script string Conditionally This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is true. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition.

Applicable values: See LanguageScriptEnum
returnDetails.address
  .stateOrProvince
string Conditionally The state or province of the address. This field is always used by containers using the Address type.
returnDetails.address
  .transliteratedFromScript
string Conditionally This enumeration value indicates the language that the address has been transliterated from. This field is only returned if transliteration was required (and the isTransliterated field is 'true'. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.

The list of language enumeration values that may be returned in this field are defined in the LanguageScriptEnum type definition.

Applicable values: See LanguageScriptEnum
returnDetails.address
  .worldRegion
string Conditionally This string value indicates the region of the world in which the address resides. This field is not always used by containers using the Address type.

The list of world region enumeration values that may be returned in this field are defined in the WorldRegionEnum type definition.

Applicable values: See WorldRegionEnum
returnDetails.editable boolean Conditionally This boolean field indicates whether or not the seller's return address (shown in the address container) can be modified. A value of true indicates that the return address can be modified, and a value of false indicates that the return address cannot be modified.
returnDetails.firstName string Conditionally The first name associated with the return address, or if applicable, a business or store name.
returnDetails.lastName string Conditionally The last name associated with the return address. This field will only be returned if applicable.
returnDetails.RMA string Conditionally The Return Merchandise Authorization (RMA) identifier authorizing this return. This field is only returned if an RMA number exists for the order line item.
returnId string Conditionally The unique identifier of a return. This field is only returned if the case type is a Return.
sellerClosureReason string Conditionally This enumeration value indicates why the seller chose to close the case. This field is only returned if the seller closed the case, or if the case was closed on behalf of the seller.

The list of enumeration values that may be returned in this field are defined in the CaseCloseReasonEnum type definition.

Applicable values: See CaseCloseReasonEnum
shippingFee Amount Conditionally This container displays the expected return shipping fees. Depending on the case type and the details of the case type, the return shipping fees may be paid by the buyer or the seller. amount that the buyer

This container is only returned if the case is expected to involve the buyer returning the item to the seller.
shippingFee
  .convertedFromCurrency
string Conditionally The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

If no conversion occurs, this should not be populated.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
shippingFee.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.
shippingFee.currency string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

The list of three-digit currency codes that may be returned in this field are defined in the CurrencyCodeEnum type definition.

Applicable values: See CurrencyCodeEnum
shippingFee.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.
shippingFee.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.
status string Always This enumeration value indicates the current status of the case.

The list of enumeration values that may be returned in this field are defined in the CaseStatusEnum type definition.

Applicable values: See CaseStatusEnum
transactionId string Always The unique identifier of the purchase transaction. 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 the line item that is associated with the case.
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:

Sample: Basic Call

Retrieve a case

Description

A seller has just realized that an Item Not Received case has been opened by a buyer, and the seller wants to find out more details about this case.

Input

The seller passes in the case ID as a path parameter. There is no request payload for this call.

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

GET https://api.ebay.com/post-order/v2/casemanagement/5********2

Output

The response of the call indicates that it is a ITEM_NOT_RECEIVED case filed against a line item that is identified through the itemId and transactionId values. The seller looks at the caseDetails.buyerInitExpectResolution to discover that the buyer still wants the item, and does not want a refund.

JSON format.
{ 
"caseId": "5********2",
"caseType": "ITEM_NOT_RECEIVED",
"itemId": "2**********0",
"transactionId": "8********0",
"status": "OPEN",
"claimAmount":
    { 
    "value": "81.0",
    "currency": "USD"
    },
"shippingFee":
    { 
    "value": "0.0",
    "currency": "USD"
    },
"caseQuantity": "1",
"initiator": "BUYER",
"creationDate":
    { 
    "value": "2015-08-29T20:18:17.000Z"
    },
"lastModifiedDate":
    { 
    "value": "2015-09-05T15:59:10.000Z"
    },
"extTransactionId": "6***************W",
"escalateReason": "OTHERS",
"escalatedBy": "BUYER",
"appealDetails":
    { 
    "eligibleForAppeal": "true"
    },
"caseDetails":
    { /* CaseDetails */
    "buyerInitExpectResolution": "Buyer still wants the item.",
    "creationDate":
		    { 
		    "value": "2015-08-29T20:18:17.000Z"
    },
    "escalationDate":
        { 
        "value": "2015-09-05T15:59:10.000Z"
        },
    "lastBuyerRespDate":
        { 
        "value": "2015-09-05T15:59:10.000Z"
        },
    "paypalPaid": "true",
"caseHistoryDetails":
    { 
    "history": [
        { 
        "date":
					{ 
					"value": "2015-08-29T20:18:17.000Z"
          },
        "action": "A case was created.",
        "actor": "BUYER",
        }
      ],
    },
}


Back to list of samples

Sample: INR case for a cross-border trade line item

Retrieve an INR case for a cross-border trade line item.

Description

A seller wants to get the current status and full details of an Item Not Received case that was opened and won by the buyer, but the seller has appealed.

Input

The seller passes in the case ID as a path parameter. There is no request payload for this call.

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

GET https://api.ebay.com/post-order/v2/casemanagement/5********2

Output

The response of the call indicates that it is a ITEM_NOT_RECEIVED case filed against a line item that is identified through the itemId and transactionId values.

Looking at the second-to-last entry in the caseHistoryDetails.history array, the claim was resolved by eBay and the buyer was refunded the full amount. As indicated in the moneyMovementEntryList.fundingSource container, eBay recouped the funds for the buyer refund through available seller payout funds. The seller was a Canadian seller that listed the item on the eBay US marketplace, so the moneyMovementEntryList.amount container shows the amount of the refund in Canadian dollars.

Finally, the caseDetails.refundChargeAmount container shows the net charge amount of the refund in Canadian dollars after the conversion of USD to CAD.

JSON format.
{
    "caseId": "5********2",
    "caseType": "ITEM_NOT_RECEIVED",
    "itemId": "2**********6",
    "transactionId": "1*********5",
    "returnId": "-1",
    "claimAmount": {
        "value": 34.67,
        "currency": "USD"
    },
    "caseQuantity": 1,
    "initiator": "BUYER",
    "creationDate": {
        "value": "2020-08-10T22:16:23.000Z"
    },
    "lastModifiedDate": {
        "value": "2020-08-12T18:01:40.000Z"
    },
    "sellerClosureReason": "UNDEFINED",
    "buyerClosureReason": "UNDEFINED",
    "escalateReason": null,
    "caseDetails": {
        "creationDate": {
            "value": "2020-08-10T22:16:23.000Z"
        },
        "expirationDate": {
            "value": "2020-08-14T07:00:00.000Z"
        },
        "escalationDate": {
            "value": "2020-08-10T22:30:40.000Z"
        },
        "refundAmounts": {
            "refundAmount": null,
            "feeCreditAmount": null,
            "buyerFinalAcceptRefundAmt": {
                "value": 0,
                "currency": "USD"
            },
            "buyerInitExpectRefundAmt": {
                "value": 0,
                "currency": "USD"
            },
            "internationalRefundAmount": null
        },
        "refundChargeAmount": {
            "value": 45.01,
            "convertedFromValue": 34.67,
            "convertedFromCurrency": "USD",
            "currency": "CAD",
            "exchangeRate": "1.29826"
        },
        "refundType": "OTHER",
        "refundDeadlineDate": {
            "value": "2020-08-15T18:01:40.000Z"
        },
        "buyerInitExpectResolution": "BOR1 - I want a full refund (without returning the item i.e. not received yet)",
        "buyerFinalAcceptResolution": "Unknown",
        "lastBuyerRespDate": null,
        "lastSellerRespDate": null
    },
    "escalatedBy": null,
    "actionDeadlines": {
        "maxDaysToFileClaim": 30,
        "daysToReturnItem": 3,
        "daysToExpireWithResponse": 21,
        "daysToExpireWithoutResponse": 21,
        "daysForBuyerToProvideProofOfShipment": -1
    },
    "priceSignatureConfirmationAmount": null,
    "appealDetails": {
        "eligibleForAppeal": false,
        "appealStatus": "OTHER",
        "appealDate": {
            "value": "2020-08-12T18:01:40.000Z"
        },
        "appealReasonCode": null,
        "appealCloseReasonEnum": "OTHER",
        "appealStatusEnum": "SELLER_APPEALED",
        "appealRefundAmount": null
    },
    "fsnadShipToSellerByDate": null,
    "status": "OTHER",
    "shippingFee": {
        "value": 0,
        "currency": "USD"
    },
    "extTransactionId": null,
    "buyerProtectedProgramLink": "http://L*************1/h**p/***/p*****************s.html",
    "payForItemLink": "http://L*************1/help/policies/unpaid-item.html",
    "recalledItemLink": "http://L*************1/help/policies/recalled.html",
    "eventTicketsLink": null,
    "returnDetails": null,
    "caseHistoryDetails": {
        "history": [
            {
                "date": {
                    "value": "2020-08-10T22:16:23.000Z"
                },
                "action": "A CPS case was created.",
                "actor": "BUYER",
                "description": "active CBT e2e testing",
                "moneyMovement": null
            },
            {
                "date": {
                    "value": "2020-08-10T22:16:59.000Z"
                },
                "action": "Auto Dispose Approve the case",
                "actor": "SYSTEM",
                "description": null,
                "moneyMovement": null
            },
            {
                "date": {
                    "value": "2020-08-10T22:30:40.000Z"
                },
                "action": "User has contacted customer support. Other party cannot see this activity.",
                "actor": "BUYER",
                "description": null,
                "moneyMovement": null
            },
            {
                "date": {
                    "value": "2020-08-10T22:34:23.000Z"
                },
                "action": "System request money movement",
                "actor": "CSR",
                "description": null,
                "moneyMovement": null
            },
            {
                "date": {
                    "value": "2020-08-10T22:39:20.000Z"
                },
                "action": "Claim was resolved.",
                "actor": "CSR",
                "description": null,
                "moneyMovement": {
                    "moneyMovementEntryList": [
                        {
                            "date": {
                                "value": "2020-08-10T22:34:21.765Z"
                            },
                            "type": "REFUND",
                            "fundingSource": {
                                "type": "AVAILABLE_FUNDS"
                            },
                            "fundingStatus": "FUNDED",
                            "amount": {
                                "value": 45.01,
                                "convertedFromValue": 34.67,
                                "convertedFromCurrency": "USD",
                                "currency": "CAD"
                            }
                        }
                    ]
                }
            },
            {
                "date": {
                    "value": "2020-08-12T18:01:40.000Z"
                },
                "action": "member appeals to claim outcome",
                "actor": "SELLER",
                "description": "Seller appeal active CBT ",
                "moneyMovement": null
            }
        ],
        "shipmentTrackingDetails": {
            "trackingURL": null,
            "trackingNumber": null,
            "carrier": null,
            "estimateFromDate": null,
            "estimateToDate": null,
            "currentStatus": null
        }
    },
    "fsnadDaysToAddTrackingAfterShippingItem": 0
}

Back to list of samples



Change History

Change Date Description