Search Cases

GET /post-order/v2/casemanagement/search

This method is used to search for return requests and Item Not Received inquiries that have been escalated to eBay cases by the buyer.

There are multiple filters available for this method, including the following:

• Searching by item ID
• Searching by order ID (or item ID/transaction ID)
• Searching by return ID
• Searching by case status
• Searching by case creation date

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/casemanagement/search?
  case_creation_date_range_from=string&
  case_creation_date_range_to=string&
  case_status_filter=CaseStatusFilter&
  fieldgroups=CaseSearchFieldGroupEnum&
  item_id=string&
  limit=integer&
  offset=integer&
  order_id=string&
  return_id=string&
  sort=string&
  transaction_id=string

URI parameters

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.

{ /* CaseSearchResponse */
"members": [
    { /* CaseSummaryType */
    "buyer": string,
    "caseId": integer,
    "caseStatusEnum": string,
    "claimAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "exchangeRate": string,
        "value": number
        },
    "creationDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "itemId": integer,
    "lastModifiedDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "respondByDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "seller": string,
    "transactionId": integer
    }
    /* More CaseSummaryType nodes here */
  ],
"paginationOutput":
    { /* PaginationOutput */
    "limit": integer,
    "offset": integer,
    "totalEntries": integer,
    "totalPages": integer
    },
"totalNumberOfCases": integer
}

Response field descriptions

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.

Search for open cases

Description

This call searches for open cases filed against the seller.

Input

To retrieve open cases only, the case_status_filter query parameter is used, and its value is set to OPEN.

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

GET https://api.ebay.com/post-order/v2/casemanagement/search?
   case_status_filter=OPEN

Output

The search revealed that the seller has only one open case filed against their account. To retrieve more information about the case, the seller will want to grab the caseId value and run a 'Get Case' call using that ID value.

JSON format.
{ 
"members": [
    { 
    "buyer": "s*************4",
    "caseId": "5********3",
    "caseStatusEnum": "OPEN",
    "claimAmount":
        { 
        "currency": "USD",
        "value": "81.0"
        },
    "creationDate":
        { 
        "value": "2015-08-29T20:18:17.000Z"
        },
    "itemId": "2**********1",
    "lastModifiedDate":
        { 
        "value": "2015-08-29T20:18:17.000Z"
        },
    "respondByDate":
        { 
        "value": "2015-09-01T20:18:17.000Z"
        },
    "seller": "f***********6",
    "transactionId": "8********1"
    }
  ],
"paginationOutput":
    { 
    "limit": 25,
    "offset": 0,
    "totalEntries": 1,
    "totalPages": 1
    },
"totalNumberOfCases": 1
}

Change History