Return notifications

When the return status notification event occurs, the seller will receive the response payload on the destination URL, as given in the samples.

RETURN_CREATED

Event Type: RETURN_CREATED
Event Version: V1
Resource Name: RETURNS

Response parameters

Name	Description	Type
source	Event meta information	Object
eventType	Event for which the notification is received	String
eventTime	Time at which the event occurs	String
eventId	Unique ID of the event	String
payload	Event details	Object
partnerId	The unique partner Id	String
partnerName	The name of the partner	String
returnOrders	The list of return order lines	List
purchaseOrderId	The purchase order ID for the return that was created	String
productName	The name of the product associated with the line item	String
returnOrderId	Return order identifier of the return order. This is the same as the RMA number	String
returnInitiatedDate	Return initiated date	String
returnReason	Gives the reason that was selected during the return creation	String
trackingUrl	Return tracking URL	List
trackingId	Return tracking Id	List
refundStatus	Refund status	String

Sample payload: RETURN_CREATED

{ "partnerId": "10900015773", "partnerName": "StageTestSeller2 llc" "returnOrders": [ { "purchaseOrderId": "RAPMOCK0000007124873", "productName": "Item 1", "returnOrderId": "100006868600000090", "returnInitiatedDate": "Mar 28, 2024", "returnReason": "Item arrived damaged", "quantity": "1", "trackingUrl": [ "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=100070000851" ], "trackingId": [ "100070000851" ], "refundStatus": "Non Refunded" } ]
}

RETURN_INVOICED

Event Type: RETURN_INVOICED
Event Version: V1
Resource Name: RETURNS

Response parameters

Name	Description	Type
source	Event meta information	Object
eventType	Event for which the notification is received	String
eventTime	Time at which the event occurs	String
eventId	Unique ID of the event	String
payload	Event details	Object
partnerId	The unique partner Id	String
partnerName	The name of the partner	String
returnOrders	The list of return order lines	List
purchaseOrderId	The purchase order ID for the return that was created	String
productName	The name of the product associated with the line item	String
returnOrderId	Return order identifier of the return order. This is the same as the RMA number	String
refundInitiatedDate	Refund initiated date	String
returnReason	Gives the reason that was selected during the return creation	String
trackingUrl	Return tracking URL	List
trackingId	Return tracking Id	List
refundStatus	Refund status	String

Sample payload: RETURN_INVOICED

{ "partnerId": "10900024715", "partnerName": "Rons Widgets Live", "returnOrders": [ { "purchaseOrderId": "RAPMOCK0000007124873", "productName": "Trunk Floor Center Panel for 1961-1964 Chevrolet", "returnOrderId": "100006868600000090", "refundInitiatedDate": "Mar 26, 2024", "returnReason": "Shipping box damaged", "quantity": "1", "trackingUrl": [ "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=100070000851" ], "trackingId": [ "100070000851" ], "refundStatus": "Refunded" } ]
}

RETURN_DELIVERED

Event Type: RETURN_DELIVERED
Event Version: V1
Resource Name: RETURNS

Response parameters

Name	Description	Type
source	Event meta information	Object
eventType	Event for which the notification is received	String
eventTime	Time at which the event occurs	String
eventId	Unique ID of the event	String
payload	Event details	Object
partnerId	The unique partner Id	String
partnerName	The name of the partner	String
returnOrders	The list of return order lines	List
purchaseOrderId	The purchase order ID for the return that was created	String
productName	The name of the product associated with the line item	String
returnOrderId	Return order identifier of the return order. This is the same as the RMA number	String
returnInitiatedDate	Return initiated date	String
returnReason	Gives the reason that was selected during the return creation	String
trackingUrl	Return tracking URL	List
trackingId	Return tracking Id	List
refundStatus	Refund status	String

Sample payload: RETURN_DELIVERED

{ "partnerId": "10900015173", "partnerName": "Shoes.com", "returnOrders": [ { "purchaseOrderId": "RAPMOCK0000007124873", "productName": "suanret Ladies Satin long sleeve pjs", "returnOrderId": "100006868600000090", "returnInitiatedDate": "Mar 12, 2024", "returnReason": "Shipping box damaged", "quantity": "1", "trackingUrl": [ "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=100070000851" ], "trackingId": [ "100070000851" ], "refundStatus": "Non Refunded" } ]
}