eBay Post-Order APIVersion 2

Get Case

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

Buyers and sellers can use this call 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 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 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": token,
    "appealDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "appealReasonCode": string,
    "appealStatus": token,
    "appealStatusEnum": string,
    "eligibleForAppeal": boolean
    },
"buyerClosureReason": token,
"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,
            "value": number
            },
        "buyerInitExpectRefundAmt":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "internationalRefundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "refundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": 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,
                    "value": number
                    },
                "date":
                    { /* DateTime */
                    "formattedValue": string,
                    "value": datetime
                    },
                "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": token,
"claimAmount":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "value": number
    },
"creationDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"escalatedBy": string,
"escalateReason": token,
"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": token,
"shippingFee":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "value": number
    },
"status": token,
"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 has to perform various actions.
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 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 Always This container consists of information related to the appeal of a case decision.
appealDetails
  .appealCloseReasonEnum
token 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 was closed.

Applicable values: See AppealCloseReasonEnum
appealDetails.appealDate DateTime Conditionally This timestamp indicates the date and time when the appeal was made. This field will only be returned if an appeal was made on the case decision.
appealDetails.appealDate
  .formattedValue
string Conditionally This field is for internal or future use.
appealDetails.appealDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
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 has made an appeal on the case decision.
appealDetails.appealStatus token 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: See AppealGrantStatusEnum
appealDetails.appealStatusEnum string Conditionally This enumeration value indicates the current status of the appeal against the case decision.

Applicable values are from AppealStatusEnum:See appealStatusEnum.
Code so that your app gracefully handles any future changes to this list.
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 token Always This enumeration value indicates why the buyer closed the case. This field is only returned if the buyer closed the case, or if the case was closed on behalf of the buyer.

Applicable values: See CaseCloseReasonEnum
buyerProtectedProgramLink string Conditionally This string 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 This timestamp indicates when the case was created.
caseDetails.creationDate
  .formattedValue
string Conditionally This field is for internal or future use.
caseDetails.creationDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

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

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

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

This field is always used for containers using the DateTime type.
caseDetails.expirationDate DateTime Always This timestamp indicates when a case will expire naturally if a required response from the buyer or seller is not made.
caseDetails.expirationDate
  .formattedValue
string Conditionally This field is for internal or future use.
caseDetails.expirationDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
caseDetails.lastBuyerRespDate DateTime Conditionally This timestamp 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 This field is for internal or future use.
caseDetails.lastBuyerRespDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
caseDetails.lastSellerRespDate DateTime Conditionally This timestamp 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 This field is for internal or future use.
caseDetails.lastSellerRespDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
caseDetails.paypalPaid boolean Conditionally This boolean field will be returned as true if the buyer paid for the order line item through PayPal.
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 The amount of money finally accepted as a refund by the buyer.
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
caseDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
Amount Conditionally The amount of money initially expected as a refund by the buyer.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
caseDetails.refundAmounts
  .buyerInitExpectRefundAmt
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
caseDetails.refundAmounts
  .internationalRefundAmount
Amount Conditionally The amount of the refund issued by the seller that applies to the international leg of a Global Shipping Program shipment.
caseDetails.refundAmounts
  .internationalRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
caseDetails.refundAmounts
  .internationalRefundAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
caseDetails.refundAmounts
  .refundAmount
Amount Conditionally The amount of the refund that the seller issued.
caseDetails.refundAmounts
  .refundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

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

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

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

This field is always used for containers using the DateTime type.
caseDetails.refundType string Conditionally This enumeration value indicates whether the seller is scheduled to, or already has issued the buyer a partial or a full 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
Indicates the seller is scheduled to, or already has issued the buyer a full refund.
OTHER
Indicates it is unknown whether the seller is scheduled to, or already has issued the buyer a full or a partial refund.
PARTIAL
Indicates the seller is scheduled to, or already has issued the buyer 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 Contains details about the previous events and actions regarding this case or inquiry.
caseHistoryDetails.history
  .action
string Always The action initiated by one of the parties involved with the inquiry or case.
caseHistoryDetails.history
  .actor
string Always The party that took this action.

Applicable values are from UserPartyEnum:

BUYER
The buyer initiated the action.
CSR
An eBay customer support representative initiated the action.
SELLER
The seller initiated the action.
SYSTEM
The eBay commerce platform initiated the action.
UNKNOWN
The initiator of the action cannot be identified.

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

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

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

This field is always used for containers using the DateTime type.
caseHistoryDetails.history
  .description
string Conditionally A description of this event or action. This field is returned if available.
caseHistoryDetails.history
  .moneyMovement
MoneyMovementEntries Conditionally Contains information about the transfers of money associated with this event or action. This field is not returned if no money was transferred.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList
array of MoneyMovementEntry Conditionally Contains details about the transfers of money associated with the current action on the inquiry or case. This container is only returned if there were monetary transactions that occurred with the current action.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.amount
Amount Conditionally The amount of money transferred.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.amount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

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

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

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

This field is always used for containers using the DateTime type.
caseHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.type
string Conditionally The purpose of the transfer.
caseHistoryDetails
  .shipmentTrackingDetails
ShipmentTrackingDetailType Conditionally Contains information for monitoring the shipment of the order associated with this case or inquiry. 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 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 field is returned if it is known and available.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateFromDate
  .formattedValue
string Conditionally This field is for internal or future use.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateFromDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate
DateTime Conditionally 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 field is returned if it is known and available.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate.formattedValue
string Conditionally This field is for internal or future use.
caseHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate.value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
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 a case.
caseQuantity integer Always This integer value indicates the quantity of the line item purchased by the buyer.
caseType token Always 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: See CaseTypeEnum
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

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

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

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

This field is always used for containers using the DateTime type.
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
The buyer initiated the action.
CSR
An eBay customer support representative initiated the action.
SELLER
The seller initiated the action.
SYSTEM
The eBay commerce platform initiated the action.
UNKNOWN
The initiator of the action cannot be identified.

Code so that your app gracefully handles any future changes to this list.
escalateReason token Always Indicates why the buyer or seller escalated an INR inquiry or a return request into a case. For an inquiry that was escalated, the applicable values are defined in the InquiryEscalationReasonEnum type. For a return request that was escalated, the applicable values are defined in the EscalateReasonEnum type.

Applicable values: See InquiryEscalationReasonEnum
eventTicketsLink string Conditionally This string 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. For some orders, this identifier may not be available.
fsnadDaysToAddTrackingAfterShippingItem integer Conditionally This integer value indicates the number of days that the buyer has to add shipment tracking information after mailing the return item back to the seller. This field is only returned if the case type is a Return.
fsnadShipToSellerByDate DateTime Conditionally This timestamp indicates the deadline when the buyer must ship the return item back to the seller. This field is only returned if the case type is a Return.
fsnadShipToSellerByDate
  .formattedValue
string Conditionally This field is for internal or future use.
fsnadShipToSellerByDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
initiator string Always This enumeration value indicates whether the buyer or the seller initiated the case.

Applicable values are from UserPartyEnum:

BUYER
The buyer initiated the action.
CSR
An eBay customer support representative initiated the action.
SELLER
The seller initiated the action.
SYSTEM
The eBay commerce platform initiated the action.
UNKNOWN
The initiator of the action cannot be identified.

Code so that your app gracefully handles any future changes to this list.
itemId string Always The unique identifier of the listing containing the line item on which the case is based upon. The itemId and transactionId values identify the order line item on which the case is based upon.
lastModifiedDate DateTime Always This timestamp indicates when the last action was performed on the case.
lastModifiedDate
  .formattedValue
string Conditionally This field is for internal or future use.
lastModifiedDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

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

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

This field is always used for containers using the DateTime type.
payForItemLink string Conditionally This string is the URL for the purchase item page. This field will be returned if available.
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.
returnDetails ReturnAddress Conditionally This container consists of information related to a buyer returning an order to the seller, including the seller's address and the RMA number (if applicable). This container is only returned if the case type is a Return.
returnDetails.address Address Conditionally Contains the the full return address.
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 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'.
returnDetails.address
  .addressType
string Conditionally This enumeration value indicates whether the address is a business, a personal address, or a PO Box. This field is not always used by containers using the Address type.

Applicable values are from AddressTypeEnum:

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

Code so that your app gracefully handles any future changes to this list.
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.

Applicable values are from CountryCodeEnum:See country.
Code so that your app gracefully handles any future changes to this list.
returnDetails.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.
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 county 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.

Applicable values are from LanguageScriptEnum:See script.
Code so that your app gracefully handles any future changes to this list.
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.

Applicable values are from LanguageScriptEnum:See transliteratedFromScript.
Code so that your app gracefully handles any future changes to this list.
returnDetails.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.
returnDetails.editable boolean Conditionally A value of true indicates that the return address can be edited.
returnDetails.firstName string Conditionally The first name associated with the return address, or if applicable, a business 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 involved the return of an item.
sellerClosureReason token Always Indicates why the seller closed the case. This field is only returned if the seller closed the case, or if the case was closed on behalf of the seller.

Applicable values: See CaseCloseReasonEnum
shippingFee Amount Always This container displays the amount that the buyer will pay for return shipping fees. This container is only return if the case is expected to involve the buyer returning the item.
shippingFee
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
shippingFee.value number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
status token Always This enumeration value indicates the current status of the case.

Applicable values: See CaseStatusEnum
transactionId string Always The unique identifier of the transaction on which the case is based upon. The itemId and transactionId values identify the order line item on which the case is based upon.
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.

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/5002645692

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": "5002645692",
"caseType": "ITEM_NOT_RECEIVED",
"itemId": "200004428880",
"transactionId": "8147050010",
"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": "6Y534764HJ266361W",
"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",
        }
      ],
    },
}



Change History

Change Date Description