The Fetch Returns API retrieves details of shipments that have been returned by the customer, including Return to Origin (RTO) shipments and shipments canceled after invoicing but before dispatch. This ensures comprehensive tracking and management of return processes within the Fynd ecosystem.
Method:
GET
Scheme:HTTPS
Endpoint:https://{{host}}/oms/v3/shipment?orderStatus=RETURN_DELIVERED
Try out Fynd Konnect's Fetch Returns Endpoint
Common Request Header
| Header | Mandatory | Description |
|---|---|---|
x-access-token | Yes | Access token used for authenticating API requests to Fynd Konnect |
Schedule periodic fetches to capture orders or returns from Fynd OMS. For industry-recommended Cron Polling Intervals, refer to our Best Practices section
Specifies the page number for paginated results.
Defines the number of results per page.
Filters orders from this date.
Filters orders up to this date.
Unique identifier for a specific order.
Specifies the sales channel (e.g., Flipkart, ECOMM, Amazon).
Filters orders by their current status.
Identifies a specific store or warehouse location.
Unique shipment identifier
Forward shipment ID (same as id for forward orders, a unique shipment id is created for returns and cancellations)
Marketplace-specific order identifier
Marketplace-specific return identifier (null for forward orders)
Marketplace-provided invoice number
Customer's shipping address details
Customer's billing primary address
Indicates if the shipment contains multiple packages
Package dimensions and weight information
Fulfillment type
Indicates if the seller has generated an invoice
Name of the assigned courier partner
Courier partner code
List of Air Waybill numbers for tracking
Additional information or notes about the order
Order pricing details
List of items in the order
Current status of the entire order (e.g., CREATED, CONFIRMED, PROCESSING, DELIVERED)
Timestamp when the order was placed
Last status modified timestamp of the shipment
Payment method (e.g., COD, Prepaid)
Indicates if the shipment is tax-exempted
GST Identification Number (IRN) for B2B orders
Date after which the order should be packed
Date by which the order must be packed
Available pickup time slots
Sales channel name for webstore or marketplace
URL for the shipping label PDF (A4 size)
URL for the shipping label PDF (A6 size)
URL for the purchase order PDF
Invoice number generated for the shipment either by Fynd or the Seller
Credit note/return invoice number generated for the shipment either by Fynd or the Seller
Invoice Reference Number (IRN) for e-invoicing
QR code data for the invoice
Digitally signed invoice data
Business type (e.g., B2C, B2B)
Indicates if the order is locked for processing
Priority level for order fulfillment
Order journey type (e.g., forward, return)
Timestamp when the invoice was generated
Tags or labels associated with the shipment
Service Level Agreement - Order processing Turn Around Time (TAT)
Indicates if C-Form has been provided for inter-state sales
Channel-specific bag identifier
Channel-specific shipment identifier
URL for the invoice PDF (A4 size)
URL for the invoice PDF (A6 size)
Indicates if the order is non-returnable
Indicates if this is a self-ship order (seller manages logistics)
- Fynd Konnect [Sandbox]https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment
curl -i -X GET \
'https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment?orderId=string&orderingChannel=string&orderStatus=RETURN_DELIVERED&pageNumber=0&pageSize=0&locationCode=string&orderDateFrom=2019-08-24&orderDateTo=2019-08-24' \
-H 'x-access-token: YOUR_API_KEY_HERE'- Once a return is delivered to the seller's warehouse, QC is performed before the return can be accepted, and the call for the same can be passed to Fynd; see Update Return & QC
- Once a return is accepted, the return process can be completed by generating a credit note if credit note auto-generation is not enabled for the merchant on their Fynd Seller Portal; see Update Credit Note
- To fetch the credit note auto-generated by Fynd, use the Customer Invoice endpoint to fetch the reverse invoice PDF against a return shipment ID