Get Returns

Get returns

GET /api/v0/returns/?fromDate=:fromDate\&toDate=:toDate

Returns details for customer returned products between the given fromDateand (optional) toDate. The API will default to the current time if the optional toDate parameter is not provided.

Sample Response

{
  "data": {
    "returnItems": [
      {
        "rmaNumber": "ERZD-2743",
        "customerOrderId": "280869",
        "customerLineItemId": "2702257",
        "productId": "326270",
        "dateOfSale": "2024-08-07T14:54:29.239Z",
        "dateReceived": "2024-08-07T14:54:29.239Z",
        "partNumber": "CS-RS64F-NB-2P",
        "returnAction": "Back in Inventory"
      }
    ]
  }
}

returnItem
`rmaNumber`	Unique Identifier that Spreetail uses to keep track of returned items
`customerOrderId`	Unique Identifier that represents a sale submitted by a PS Brand
`customerLineItemId`	Identifier that represents the individual item within a sale
`productId`	The fulfillment center from where the package originated
`dateOfSale`	The date that the sale occurred
`dateReceived`	The date the item was received by the reverse logistics team
`partNumber`	The name of the product within Spreetail’s system
`returnAction`	The action that was taken once the product was returned to Spreetail