eBay Post-Order APIVersion 2

Get Inquiry

GET /post-order/v2/inquiry/{inquiryId}

Retrieves details about the specified inquiry and a summary of the activity to date with respect to the specified inquiry. The summary includes any actions taken by the buyer, the seller, the Inquiry service, or customer support representatives.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/inquiry/{inquiryId}

URI parameters

Parameter Type Required? Meaning
inquiryId string Required The unique ID of the inquiry for which details and history are to be retrieved.

Note: This is the value that was returned by the POST /post-order/v2/inquiry/ call in an HTTP location code: /post-order/v2/inquiry/{INQUIRYID}, in which INQUIRYID identifies the newly created inquiry.


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.

{ /* InquiryDetailsResponse */
"claimAmount":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "value": number
    },
"extTransactionId": string,
"initiator": string,
"inquiryDetails":
    { /* InquiryDetails */
    "appealDetails":
        { /* AppealDetails */
        "appealCloseReasonEnum": token,
        "appealDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "appealReasonCode": string,
        "appealStatus": token,
        "appealStatusEnum": string,
        "eligibleForAppeal": boolean
        },
    "creationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "escalationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "expirationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "lastBuyerRespDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "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
        },
    "totalAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "value": number
        }
    },
"inquiryHistoryDetails":
    { /* 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
        }
    },
"inquiryId": string,
"inquiryQuantity": integer,
"itemDetails":
    { /* ItemDetails */
    "itemPictureUrl": string,
    "itemPrice":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "value": number
        },
    "itemTitle": string,
    "viewPurchasedItemUrl": string
    },
"itemId": 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
    },
"sellerMakeItRightByDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"shippingCost":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "value": number
    },
"state": token,
"status": token,
"transactionId": string,
"viewPPTrasanctionUrl": string
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
claimAmount Amount Always This container displays the dollar value of the order line item associated with the inquiry, which is generally the amount of the refund that the buyer will receive if the buyer is looking for a refund, or if the seller voluntarily refunds the buyer.

Note: There's a possibility that this value can be inaccurate if the buyer passed in an inaccurate value into the claimQuantity field when the inquiry was created.
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.
extTransactionId string Conditionally This string value is the unique identifier of the payment transaction for the order.
initiator string Always The party who created this inquiry. In most cases, this value will be BUYER, but the UserPartyEnum type has the complete list of possible values.

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.
inquiryDetails InquiryDetails Conditionally Contains the details of the specified inquiry.
inquiryDetails.appealDetails AppealDetails Conditionally This container consists of information related to the appeal of a case decision. This container is only returned for a inquiry that was escalated into a case.
inquiryDetails.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
inquiryDetails.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.
inquiryDetails.appealDetails
  .appealDate.formattedValue
string Conditionally This field is for internal or future use.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.creationDate DateTime Always This timestamp indicates when the inquiry was created by the buyer.
inquiryDetails.creationDate
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryDetails.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.
inquiryDetails.escalationDate DateTime Conditionally This timestamp indicates when the inquiry was escalated to a case. This field is not returned if the inquiry was not escalated.
inquiryDetails.escalationDate
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryDetails.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.
inquiryDetails.expirationDate DateTime Always This timestamp indicates when the inquiry will naturally expire if no further action is taken.
inquiryDetails.expirationDate
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryDetails.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.
inquiryDetails
  .lastBuyerRespDate
DateTime Always This timestamp indicates when the buyer last responded to, or performed an action on the inquiry.
inquiryDetails
  .lastBuyerRespDate
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryDetails
  .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.
inquiryDetails.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.
inquiryDetails.refundAmounts
  .buyerFinalAcceptRefundAmt
Amount Conditionally The amount of money finally accepted as a refund by the buyer.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.refundAmounts
  .buyerInitExpectRefundAmt
Amount Conditionally The amount of money initially expected as a refund by the buyer.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.refundAmounts
  .refundAmount
Amount Conditionally The amount of the refund that the seller issued.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails.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.
inquiryDetails
  .refundDeadlineDate
DateTime Conditionally This timestamp indicates when the seller is required to issue a refund for the INR inquiry. This container is only returned if the buyer is seeking a full refund and no longer wants the missing item.
inquiryDetails
  .refundDeadlineDate
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryDetails
  .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.
inquiryDetails.totalAmount Amount Always The total cost of the order, including the item price and shipping fees. This will generally be the amount that the buyer will expect to receive if the buyer is seeking a full refund for the missing item.
inquiryDetails.totalAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
inquiryDetails.totalAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
inquiryHistoryDetails ClaimHistoryResponse Always Contains information about the events and actions that occurred throughout the course of the specified inquiry.
inquiryHistoryDetails.history array of ClaimHistoryEventModel Always Contains details about the previous events and actions regarding this case or inquiry.
inquiryHistoryDetails.history
  .action
string Always The action initiated by one of the parties involved with the inquiry or case.
inquiryHistoryDetails.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.
inquiryHistoryDetails.history
  .date
DateTime Always Contains a timestamp indicating the date of this event or action.
inquiryHistoryDetails.history
  .date.formattedValue
string Conditionally This field is for internal or future use.
inquiryHistoryDetails.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.
inquiryHistoryDetails.history
  .description
string Conditionally A description of this event or action. This field is returned if available.
inquiryHistoryDetails.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.
inquiryHistoryDetails.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.
inquiryHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.amount
Amount Conditionally The amount of money transferred.
inquiryHistoryDetails.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.
inquiryHistoryDetails.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.
inquiryHistoryDetails.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.
inquiryHistoryDetails.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.
inquiryHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.date
DateTime Conditionally Contains a timestamp indicating the date of the transfer.
inquiryHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.date
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryHistoryDetails.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.
inquiryHistoryDetails.history
  .moneyMovement
  .moneyMovementEntryList.type
string Conditionally The purpose of the transfer.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .shipmentTrackingDetails
  .estimateFromDate
  .formattedValue
string Conditionally This field is for internal or future use.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .shipmentTrackingDetails
  .estimateToDate.formattedValue
string Conditionally This field is for internal or future use.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .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.
inquiryHistoryDetails
  .shipmentTrackingDetails
  .trackingURL
string Conditionally This field provides the URL to the shipping carrier's shipment tracking page. This field is returned if available.
inquiryId string Always The unique identifier of the inquiry for which details have been retrieved. All information returned in the response is relevant to this specific inquiry.
inquiryQuantity integer Always This integer is the quantity of the line item purchased by the buyer. This value is the same value passed into the claimQuantity field when the inquiry was created. If the claimQuantity field was omitted when the inquiry was created, this value defaults to 1.
itemDetails ItemDetails Always This container consists of details related to the item associated with the INR inquiry, including the item title, price, and the URL of the item picture.
itemDetails.itemPictureUrl string Conditionally This field provides the URL where the picture of the item may be viewed. This field is returned when available.
itemDetails.itemPrice Amount Always The final price of the item, or the amount of money that the buyer agreed to pay for the item.
itemDetails.itemPrice
  .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.
itemDetails.itemPrice
  .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.
itemDetails.itemPrice.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.
itemDetails.itemPrice.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.
itemDetails.itemTitle string Always The title of the listing.
itemDetails
  .viewPurchasedItemUrl
string Conditionally This field provides the URL to the item purchase page. This field is returned when available.
itemId string Always The unique identifier that uniquely identifies the item listing associated with the inquiry. The itemId and transactionId identify the order line item associated with the inquiry.
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 under the following circumstances:
  • The INR inquiry was escalated to a case.
  • The seller already shipped the order line item
  • The buyer's desired outcome upon creating the INR inquiry was to get a full refund for the missing order line item
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.
sellerMakeItRightByDate DateTime Always Contains a timestamp indicating when the seller is expected to resolve this inquiry.
sellerMakeItRightByDate
  .formattedValue
string Conditionally This field is for internal or future use.
sellerMakeItRightByDate.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.
shippingCost Amount Conditionally The cost of shipping the order line item associated with this inquiry.
shippingCost
  .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.
shippingCost
  .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.
shippingCost.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.
shippingCost.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.
state token Always Indicates the current state of the INR inquiry.

Applicable values: See InquiryStateEnum
status token Always Indicates the current status of the INR inquiry.

Applicable values: See InquiryStatusEnum
transactionId string Always The unique identifier that uniquely identifies the transaction associated with the inquiry. The itemId and transactionId identify the order line item associated with the inquiry.
viewPPTrasanctionUrl string Conditionally This string value is the link to PayPal transaction page. This field is only returned if the payment method was PayPal and if the page is available.



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: Get Inquiry Details

This operation returns information about an INR inquiry.

Description

Use this operation to retrieve full details about the inquiry, including any actions taken by the buyer, the seller, the Inquiry service, and eBay customer support representatives.

Input

There is no input payload with this request. Supply the inquiry ID as a path parameter in the call.

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

GET https://api.ebay.com/post-order/v2/inquiry/5003176669

Output

The information returned by this operation includes the amount (EUR 131) that this claim is worth to the buyer; the identity of the inquiry's initiator (the buyer); the identity, details, and number of units in the order line item; the deadline for the seller to resolve this inquiry; the current status of this inquiry; as well as shipment tracking details, and the various events and actions taken to date with regard to this inquiry. The key dates, amounts, and appeal information for this inquiry are also returned.

JSON format.
{
  "inquiryId": "5003176669",
  "itemId": "290010050800",
  "transactionId": "8804694019",
  "claimAmount": {
    "value": 131.0,
    "currency": "EUR"
  },
  "shippingCost": {
    "value": 0.0,
    "currency": "EUR"
  },
  "inquiryQuantity": 1,
  "initiator": "BUYER",
  "sellerMakeItRightByDate": {
    "value": "2015-06-25T18:59:31.000Z"
  },
  "status": "CLOSED",
  "extTransactionId": "02B58433U0359941A",
  "inquiryDetails": {
    "creationDate": {
      "value": "2015-06-26T16:47:56.000Z"
    },
    "expirationDate": {
      "value": "2015-09-26T16:47:56.000Z"
    },
    "totalAmount": {
      "value": 131.0,
      "currency": "EUR"
    },
    "refundDeadlineDate": {
      "value": "2015-08-01T19:13:55.000Z"
    },
    "lastBuyerRespDate": {
      "value": "2015-07-01T19:13:55.000Z"
    }
  },
  "itemDetails": {
    "itemTitle": "Single item Single seller Order PPThu Jan 15 03:19:06 MST 2015",
    "itemPrice": {
      "value": 131.0,
      "currency": "EUR"
    },
    "itemPictureUrl": "https://i.ebayimg.ebay.com/00/s/MTA2NxNjAw/z/OSwAAOoZUt5Qm/$_1.JPG?set_id=8...00500F",
    "viewPurchasedItemUrl": "https://cgi.de.paradise.ebay.com/ws/eBayISAPI.dll?ViewItemVersion&item=290...800&tid=880..4019&view=all"
  },
  "viewPPTrasanctionUrl": "https://payments.ebay.com/ws/eBayISAPI.dll?UnifiedCheckoutSummaryRedirect2PP&buyerorseller=0&itemid=2900...00&transid=8804...190"
}



Change History

Change Date Description