f21981db32be
Returns a list of returns
Get all returns.
Query parameters
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
- eq—return values where the createdTime field equals to this timestamp
- gt—return values where the createdTime field is after this timestamp
- gte—return values where the createdTime field is after or equal to this timestamp
- lt—return values where the createdTime field is before this timestamp
- lte—return values where the createdTime field is before or equal to this timestamp
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects with these IDs.
The order to retrieve returns for.
The type of return.
Response
200 OK
Example response
{
"hasMore": true,
"data": [
{
"id": "ret_5823594809",
"createdTime": "2018-04-25T20:36:00Z",
"orderId": "6645940010",
"rmaNumber": "2343256645940010",
"reason": "requested_by_customer",
"type": "authorized",
"returnTo": {
"address": {
"line1": "10380 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "jsmith@digitalriver.com",
"organization": "Digital River",
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"items": [
{
"itemId": "99341140336",
"productDetails": {
"id": "100067660336",
"skuGroupId": "wireless-keyboards",
"name": "Keyboard",
"description": "Top rated keyboard",
"itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
"url": "https://producturl.com",
"countryOfOrigin": "US",
"image": "https://imageurl.com",
"weight": 20.5,
"weightUnit": "oz",
"partNumber": "SWG1224J10L",
"partnerAccountId": "00g6atnynbl2wFsFG357"
},
"quantity": 1,
"condition": "broken"
}
]
}
]
}