Documentation

eBay Search Cases by Criteria

Overview

This action retrieves the details of cases based on the provided search criteria from eBay's Post-Order API.

Inputs

appIdStringeBay Application ID
certIdStringeBay Certificate ID
refreshTokenStringeBay Refresh Token
limitStringLimit for the number of cases to return (default is 200)
marketPlaceIDStringeBay Marketplace ID (e.g., EBAY_UK)
searchCriteriaObjectCriteria to search cases

Outputs

SuccessBooleanWhether successfully retrieved the cases
Case ListArrayList of cases matching the search criteria
Total Number of CasesNumberTotal number of cases found
Pagination OutputObjectInformation about the pagination of results

Examples

The following action will search for cases with a limit of 50 and specific search criteria:

{
  "appId": "YourAppID",
  "certId": "YourCertID",
  "refreshToken": "YourRefreshToken",
  "limit": "50",
  "marketPlaceID": "EBAY_UK",
  "searchCriteria": {
    "caseType": "ITEM_NOT_RECEIVED",
    "creationDateRange": {
      "fromDate": "2023-01-01T00:00:00.000Z",
      "toDate": "2023-06-30T23:59:59.999Z"
    }
  }
}

This query returns the following data on success:

{
  "success": true,
  "data": [
    {
      "caseId": "XXXXXX",
      "caseType": "ITEM_NOT_RECEIVED",
      "itemId": "1234567890",
      "transactionId": "0987654321",
      "status": "OPEN",
      // Other case details...
    },
    // More cases...
  ],
  "totalNumberOfCases": 100,
  "paginationOutput": {
    "totalPages": 2,
    "pageNumber": 1
  }
}

On failure, it returns:

{
  "success": false,
  "data": {
    "message": "Failed to search cases"
  }
}