UNunified
commerce
return

List all returns

Changed on

Returns a list of CommerceReturns. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/commerce/{connection_id}/return

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

order_idstring

The AccountingOrder ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

order_idstring
status'REQUESTED' | 'OPEN' | 'APPROVED' | 'REJECTED' | 'CLOSED' | 'CANCELLED' | 'OTHER'
typestring
currencystring
total_refund_amountnumber
customer_emailstring
customer_namestring
return_by_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Changes