Skip to navigation
RESTFeedAMP Order V2Returns

Get returns filtered by search parameters

Get all returns that match the parameters that you have submitted. The maximum recommended call frequency for retrieving data from this endpoint is 2 requests per second.

Authentication

tokenstring

The Authentication token obtained from the get_token route.

OR
x-api-keystring
The SSO token obtained from the Feedonomics platform SSO token route.

Headers

clientintegerRequired
The ID of the client making the request

Query parameters

marketplace_statestringOptional

The state of the return. Multiple states can be matched by specifying a comma-separated list of values.

marketplace_state_changed_afterdatetimeOptional

Marketplace state was last changed after this datetime. RFC-3339 date-time format — fractional seconds not allowed

marketplace_state_changed_beforedatetimeOptional

Marketplace state was last changed before this datetime. RFC-3339 date-time format — fractional seconds not allowed

imported_afterdatetimeOptional

Returns created in FeedAMP after this datetime. RFC-3339 date-time format — fractional seconds not allowed

imported_beforedatetimeOptional

Returns created in FeedAMP before this datetime. RFC-3339 date-time format — fractional seconds not allowed

normalized_marketplace_stateenumOptional

FeedAMP’s interpretation of the marketplace state

  • PENDING_AUTHORIZATION - Return where the sales channel is awaiting authorization from the seller to approve the return request. Not used by all channels.
  • PENDING_CONFIRMATION - Used to denote that the return is awaiting confirmation of an event, initiated by the seller or customer. For example, if the customer is returning items to the seller, the return will remain in this state until the seller confirms the receipt and condition of the items. If the items are being returned to the channel, the return may stay in this state until the package is scanned in by the carrier. Not used by all channels.
  • CONFIRMED - Indicates that action that caused the return to be in PENDING_CONFIRMATION has been completed. Not used by all channels.
  • PENDING_REFUND - The channel is awaiting the seller to submit the amount to be refunded. For example, the channel may allow a restocking fee, so an amount lower than what was requested may be refunded. Not used by all channels.
  • UNKNOWN - Indicates that the return’s marketplace_state is not recognized by FeedAMP. This usually indicates that the return requires manual intervention by the seller through the channel’s portal
  • CANCELLED - The return has been cancelled and no further action is required.
  • COMPLETE - The return is recognized as being complete by the channel.

idstringOptional

FeedAMP return ID. May be a comma-delimited list of multiple IDs.

marketplace_return_numberstringOptional

The primary return ID provided by the marketplace. May be a comma-delimited list of multiple values.

rmastringOptional

RMA ID of a return. May be a comma-delimited list of multiple values.

customer_order_numberstringOptional

The customer-facing order number associated with this return. May be a comma-delimited list of multiple values.

return_typeenumOptional
Filter returns by the return type
Allowed values:
integration_idstringOptional
FeedAMP integration ID to limit results to a single integration
limitintegerOptional1-250Defaults to 100
The max number of records in the response
cursorstringOptional
Cursor for the next page of records
include_orderbooleanOptional
Include the order data, associated with the return, in response

Response

List of returns
returnslist of objects
next_cursorstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error