Returns
Last updated
Last updated
A return represents the full or partial return of items in an order. Returns are always associated with an order and may optionally contain a refund.
Returns all or part of a previously created order.
/returns
The unique identifier of the Order associated with the Return.
ord_6645940010The reason for the return.
requested_by_customerKey-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Get all returns.
/returns
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:
createdTime[gt]=2020-09-22T12:09:44ZA 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.
Only return objects in the given state
The order to retrieve returns for.
The sku to retrieve returns for.
Retrieves the details of a return. Supply the unique identifier of the return.
/returns/{id}
Return ID
Updates an existing return.
/returns/{id}
Return ID
Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Enumeration indicating the state of the return.
acceptedaccepted