Fetch Returns

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.

Important Considerations

Schedule periodic fetches to capture orders or returns from Fynd OMS. For industry-recommended Cron Polling Intervals, refer to our Best Practices section

Query

pageNumberinteger

Specifies the page number for paginated results.

pageSizeinteger

Defines the number of results per page.

orderDateFromstring(date)

Filters orders from this date.

orderDateTostring(date)

Filters orders up to this date.

orderIdstring

Unique identifier for a specific order.

orderingChannelstring

Specifies the sales channel (e.g., Flipkart, ECOMM, Amazon).

orderStatusstringrequired

Filters orders by their current status.

Value"RETURN_DELIVERED"

locationCodestring

Identifies a specific store or warehouse location.

Success Resposne

idstring

Unique identifier for the shipment or order

forwardIdstring

Forward ID if this is a return, else same as shipment id

marketplaceOrderIdstring

Marketplace-provided order ID if applicable

shippingAddressobject

orderItemsArray of objects(OrderItem)

orderStatusstring

Current status of the entire order

orderDatestring(date-time)

Timestamp when the order was placed

orderingChannelstring

Sales channel like FYND, JIOMART, ECOMM, etc.

API Call Example

curl -i -X GET \
  'https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment?locationCode=string&orderDateFrom=2019-08-24&orderDateTo=2019-08-24&orderId=string&orderStatus=RETURN_DELIVERED&orderingChannel=string&pageNumber=0&pageSize=0' \
  -H 'x-access-token: YOUR_API_KEY_HERE'

Response

application/json

[
  {
    "id": "17328629784861446350",
    "forwardId": "17328629784861446350",
    "marketplaceOrderId": "FY674964020E8E174561",
    "marketplaceReturnId": null,
    "marketplaceInvoiceNumber": null,
    "shippingAddress": { … },
    "billingAddress": { … },
    "multiPackShipment": false,
    "packages": [ … ],
    "fulfillmentType": "marketplaceFulfilled",
    "sellerInvoiced": false,
    "courierName": "Fynd-Test",
    "courierCode": "Fynd-Test",
    "awbNumber": [],
    "additionalInfo": "You can add additional info here",
    "orderPrice": { … },
    "orderItems": [ … ],
    "orderStatus": "DELIVERED",
    "orderDate": "2025-01-25T12:19:38+00:00",
    "modifiedDate": "2025-01-30T12:21:04",
    "paymentType": "COD",
    "taxExempted": false,
    "gstin": null,
    "packAfterDate": null,
    "packByDate": null,
    "pickUpSlots": [],
    "orderingChannel": "Konnect Test",
    "labelPdfUrl": null,
    "purchaseOrderPdfUrl": null,
    "invoiceNumber": null,
    "returnInvoiceNumber": null,
    "irnNumber": null,
    "invoiceQrCode": null,
    "signedInvoice": null,
    "orderBusinessType": "B2C",
    "lockStatus": false,
    "fulfillmentPriority": null,
    "journeyType": "forward",
    "cformProvided": false,
    "A4invoicePdfUrl": null,
    "A6invoicePdfUrl": "https://storage.googleapis.com/fynd-staging-assets-private/...",
    "is_returnless": false,
    "is_self_ship": true
  }
]

Next Steps

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