eBay Post-Order APIVersion 2

Get Return Rule History

GET /post-order/v2/rules/{ruleId}/get_trigger_history

This call is used by the seller to retrieve a history of return requests processed by a specific return rule. The specific return rule is identified in the call path. The seller also has the options of retrieving return requests by date range and/or to use pagination to customize the subset of return requests that are retrieved.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/rules/{ruleId}/get_trigger_history?
  limit=integer&
  offset=integer&
  trigger_date_range_from=string&
  trigger_date_range_to=string

URI parameters

Parameter Type Required? Meaning
limit integer Optional This integer value is used to specify the maximum number of return requests to display on a single 'page' of data. This value, along with the number of return requests that match the input criteria, will determine the total pages (see paginationOutput.totalPages) in the result set. The maximum value is 200 and the default value is 25 return requests per page. The return requests that are actually retrieved (and those that are left out) will be determined by the settings specified in the sort container.
offset integer Optional This value sets the results page to return in the current call. Page '1' of results is returned if this query parameter isn't used. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results in the paginationOutput container of your initial call).
ruleId string Required The unique identifier of a return rule. eBay automatically assigns an ID to a return rule onces the seller creates and activates the rule. This path parameter is required, as it is needed to identify the return rule upon which the seller wishes to retrieve history.
trigger_date_range_from string Optional The trigger_date_range_from and trigger_date_range_to query parameters are used if the user wants to retrieve return requests that were created during a specific time range. The starting date range is input into the trigger_date_range_from query parameter. The trigger_date_range_from date must be older than the trigger_date_range_to date, and it cannot be set back more than 18 months in the past. If the trigger_date_range_from query parameter is used, but the trigger_date_range_to query parameter is not used, the call will look for all return requests created at or after this date/time, going forward 90 days from this date. The ISO date format should be used for this query parameter. Here's a sample of that format: 2015-05-15T03:52:39.000Z.
trigger_date_range_to string Optional The trigger_date_range_from and trigger_date_range_to query parameters are used if the user wants to retrieve return requests that were created during a specific time range. The ending date range is input into the trigger_date_range_to query parameter. The trigger_date_range_to date must be more recent than the trigger_date_range_from date. If the trigger_date_range_from query parameter is used, but the trigger_date_range_to query parameter is not used, the call will look for all return requests created at or after the trigger_date_range_from value, going forward 90 days from this date. The ISO date format should be used for this query parameter. Here's a sample of that format: 2015-05-15T03:52:39.000Z.


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.

Supported response formats: application/json, application/xml

For more information:
- See GetDispositionRuleTriggerHistResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetDispositionRuleTriggerHistResponse */
"historyDetail": [
    { /* RuleTriggerHistDetailType */
    "itemId": integer,
    "returnDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "returnId": integer
    }
    /* More RuleTriggerHistDetailType nodes here */
  ],
"paginationOutput":
    { /* PaginationOutput */
    "limit": integer,
    "offset": integer,
    "totalEntries": integer,
    "totalPages": integer
    }
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
historyDetail array of RuleTriggerHistDetailType Conditionally This container consists of an array of one or more return requests that the return rule specified in the call request was applied towards. If the specified return rule was not applied towards any return requests, this container will not be returned.
historyDetail.itemId integer Always The unique identifier of the eBay listing against which a return request has been opened.
historyDetail.returnDate DateTime Always The timestamp that indicates when the return rule was triggered.
historyDetail.returnDate
  .formattedValue
string Conditionally Reserved for future use.
historyDetail.returnDate.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.
historyDetail.returnId integer Always The unique identifier of a return request.
paginationOutput PaginationOutput Always This container consists of pagination details of a call's output data.
paginationOutput.limit integer Always The maximum number of entries to return per request. The value of the totalEntries field divided by the value of this field determines the value of the totalPages field. This value cannot be higher than the number of entries that match the input criteria.
paginationOutput.offset integer Always Identifies the specific page of data to be returned by the request.

The total number of pages in the result set is determined by the total number of entries matching the request criteria (totalEntries), divided by the number of entries to display per page of data (as specified by limit). If there are multiple pages of entries to view (see totalPages), make multiple requests to view all entries and increment the page number by 1 in each subsequent request.

Default: 1
paginationOutput.totalEntries integer Always The total number of entries that match the current input criteria of the request. This value divided by the value of the limit field determines the value of the totalPages field.

Once this number of response set is known, you can modify the input to get the results you desire.
paginationOutput.totalPages integer Always The total number of pages of entries that match the current input criteria of the request.

This value is determined by dividing the value of the totalEntries field by the value of the limit field. If totalPages is more than 1, this call must be issued multiple times to view all result pages, with the page number value being incremented by 1 in each subsequent call.



Samples

Code samples not yet added for this call's documentation.



Change History

Change Date Description