eBay Post-Order APIVersion 2.7.3
 

Close Case

POST /post-order/v2/casemanagement/{caseId}/close

This method can be used on behalf of buyers to close an open case. Buyers can close an INR case after the item arrives, and they might close a Return case if they decide to keep the item, or have otherwise worked out an agreement with the seller.

Input

See also Samples.

Resource URI (production)

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

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 that is being closed. The case ID value is passed in as part of the call URI.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

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

{ /* BuyerCloseCaseRequest */
"closeReason": string,
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
closeReason string Required This field is used to provide a reason why the buyer is closing the case. One of the values in the BuyerCloseReasonEnum type (shown below) must be used. If the OTHER value is passed in, the buyer should use the comments container to provide some more details on why the case is being closed.

Applicable values are from BuyerCloseReasonEnum:

ITEM_ARRIVED
This enumeration value indicates that the buyer closed the INR inquiry or case because the item arrived.
OTHER
This enumeration value indicates that the buyer closed the INR inquiry or case for an undisclosed reason.
WORKED_OUT_WITH_SELLER
This enumeration value indicates that the buyer closed the INR inquiry or case after working out a solution with the seller.
WOULD_RATHER_KEEP_THE_ITEM
This enumeration value indicates that the case is being closed because the buyer has decided to keep the item. This value cannot be used as a closeReason in a POST /post-order/v2/inquiry/{inquiryId}/close request.
comments Text Optional This container can be used if the buyer wants to provide more details on why the case is being closed.
comments.content string Conditional This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
comments.language string Conditional This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

The full list of language enumeration values are defined in the LanguageEnum type definition.

Applicable values: See LanguageEnum
comments.translatedFromContent string Conditional If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
comments
  .translatedFromLanguage
string Conditional If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

The full list of language enumeration values are defined in the LanguageEnum type definition.

Applicable values: See LanguageEnum

Output

See also Samples.

Payload model

This call has no response payload.

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

Closing a case

Description

This call allows a buyer or seller to close a case before eBay customer support makes a decision on the case. In this particular sample, it is the buyer that is closing an INR case after finally receiving the item from the seller.

Input

The buyer passes in the case ID value as a path parameter to identify the case that is being closed. The closeReason field is required and the seller's reason for closing the case is ITEM_ARRIVED. The buyer also includes the optional comments container to provide a little more detail.

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

POST https://api.ebay.com/post-order/v2/casemanagement/5********3/close
{ 
"closeReason": "ITEM_ARRIVED",
"comments":
    { 
    "content": "I am closing the case because the item has arrived."
    }
}

Output

There is no output payload with this response. A successful call contains an HTTP status code of 200.

JSON format.



Change History

Change Date Description