Search for Return
The Search Return API offers a means of locating an existing return by specifying one or more possible properties. A specific Return ID does not have to be known to perform the search, as the response will return all results that fit the criteria. This guide demonstrates how to find returns based on parameters other than the Return ID.
The .json address above can be used to access the schema within Postman. An example use of the API follows below, or view the schema or the sample Postman collection.
The request itself is built within the URL by adding a “/?” to the call followed by specific parameters joined by the “&” symbol. For instance, searching for closed returns from a particular order would use the following format:
- https://integration.shopatron.com/api/v2/return/?orderID=[Order ID]&status=CLOSED
In the case of performing a search with multiple terms of the same parameter, such as retrieving multiple order IDs at once, use a comma-separated list as shown below.
- https://integration.shopatron.com/api/v2/return/?orderID=[Order ID One],[Order ID Two],[Order ID Three]
GET calls that support pagination for numerous results, such as when searching, also accept a perPage parameter that defines how many results can be returned on each page. The default is 10 and the maximum is 100. Switch between pages of results by appending the page parameter to the call. For example:
- https://integration.shopatron.com/api/v2/return/?orderID=[Order ID]&perPage=2&page=2
This example case creates a call that will search for all standard returns from a particular manufacturer. The request will specify the following properties:
- Manufacturer ID – 111111
- Refund Status – CLOSED
A variety of possible properties can be used to locate an existing return. The API call always requires at least one of these data points to reference as a search term:
|returnID||integer||A unique identifier for a return. The minimum value is “1”.|
|orderID||string||A single or list of unique identifiers for orders. They must be positive integers.|
|externalOrderID||string||A client-generated unique identifier for the order. The minimum length is 1 and the maximum length is 100.|
|shipmentID||string||A single or list of unique identifiers for shipments. They must be positive integers.|
|manufacturerID||string||A single or list of unique identifiers for manufacturers. They must be positive integers.|
|retailerID||string||A single or list of unique identifiers for retailers. They must be positive integers.|
|page||integer||The page number to begin listing the results from. The default and minimum value is “1”. While this parameter is technically required, this default means that it does not have to be provided in the request unless a different page is specifically desired. Also, note that the page cannot be the sole parameter in the search query – if provided, there must be at least one of the other parameters in this table.|
With at least one of the data points from above, the API can also search for any of these additional elements:
|status||enum||The status of the return (OPEN, PROCESSING, or CLOSED).|
|createdTimeFrom||string||Search for returns created on or after this date. Supports date-time format.|
|createdTimeTo||string||Search for returns created on or before this date. Supports date-time format.|
|perPage||integer|| The (max) number of items to return per page. The minimum value is “1” and the maximum value is “100”. The default is “10”.|
|sortBy||string||The field(s) to sort results by, use a minus (-) in front of field name for descending, a plus (+) for ascending. The minimum length is 1.|
The Full Request
Using the URL format as outlined above, the entire call is fairly simple to put together. This sample will search for returns matching the example’s parameters. Any amount of additional parameters could be appended if desired.
The Full Response
The API returns the following response. The object returned is a Collection, which contains all of the return results that fit the provided information. The response details all of the information associated with the return: general information and item details. It follows the same organizational structure as the standard Get Return Information response.
In this case, the search returned a single return (Return ID 00000000).
"reason": "Product ran small/large",