GET /return-events

Retrieve return events from the Maven system

This endpoint will retrieve a company's return events.

  • Each event is a JSON object containing an event ID, event type, timestamp (of when the event was saved in Maven's system), and a data object for the event.
  • Events are stored for 30 days. After 30 days, the event is deleted from the system and can no longer be retrieved.
  • This endpoint utilizes cursor based pagination to retrieve results. Read more about pagination.
  • If events need to be re-read for a given time period, utilize the cursor to go back in time.
  • If a specific list of events needs to be re-read, pass in the list of IDs into the request.

For full documentation on Return Events, visit the Return Events Guide.

Note: If you want to requery the API to return a specific list of IDs, the startTime field is still required. Ensure the startTime passed in is the time stamp of the earliest ID in the list you want to requery.

Language
Credentials
Header
Click Try It! to start a request and see the response here!