Fetch Orders
Use the Fetch Orders endpoint to retrieve shipments based on their current status, with the option to filter by date ranges, order IDs, ordering channels, and location codes.
Request Type:
GET
Scheme:HTTPS
Endpoint:https://{{host}}/oms/v3/shipment
Try out Fynd Konnect's Fetch Orders 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
Query
Filter shipments by the sales channel (e.g., FYND, JIOMART, ECOMM, etc.)
Filters orders by current status (CREATED, CONFIRMED, PROCESSING, etc.)
Page number for paginated results
Number of results per page
Store or warehouse location code. If using Company-level auth, locationCode is mandatory
Filters orders from this date (dd-mm-yyyy)
Filters orders up to this date (dd-mm-yyyy)
Use query parameters like orderStatus
, pageNumber
, and locationCode
(only required in the case of company-level auth) to refine the results.
Success Resposne
Unique identifier for the shipment or order
Forward ID if this is a return, else same as shipment id
Marketplace-provided order ID if applicable
Current status of the entire order
Timestamp when the order was placed
Sales channel like FYND, JIOMART, ECOMM, etc.
API Call Example
- Fynd Konnect [Sandbox] https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment
- Ginesys <> Konnect [Sandbox] https://ginesys.konnect.uat.fyndx1.de/oms/v3/shipment
- Unicommerce <> Konnect [Sandbox] https://unicommerce.konnect.uat.fyndx1.de/oms/v3/shipment
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=string&orderingChannel=string&pageNumber=0&pageSize=0' \
-H 'x-access-token: YOUR_API_KEY_HERE'
[ { "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 } ]
Supported Ordering Channels
Below are the orderingChannel
values supported by Fynd Konnect. They reflect different marketplace or sales channels from which the orders originate.
Channel | Overview and Usage |
---|---|
FYND-STORE |
|
FYND |
|
ECOMM |
|
AMAZON_MLF |
|
MYNTRA_IN |
|
UNIKET |
|
TATACLIQ_IN |
|
FLIPKARTASSURED |
|
AJIO_VMS |
|
TATACLIQ_LUXURY |
|
NYKAA_FASHION |
|
NYKAA |
|
TRELL |
|
MAGICPIN |
|
SHOPIFY_IN |
|
FLIPKART |
|
JIOMART |
|
FY_NEXUS |
|
Order Status
By specifying the orderStatus
query parameter, you can filter orders based on their lifecycle stage within Fynd OMS.
Status | Description |
---|---|
CREATED |
|
CONFIRMED |
|
PROCESSING |
|
COMPLETED |
|
TRANSIT |
|
HANDED_OVER_TO_CUSTOMER |
|
DELIVERED |
|
RETURN_PROCESSING |
|
RETURN_DELIVERED |
|
RETURN_COMPLETED |
|
CANCELLED |
|
CREDIT_NOTE_GENERATED |
|
- To fetch an order by its shipment ID, see Order by ID.
- To fetch customer returns, see Returns
- For bulk cancellations or partial item cancellations, see Order Cancellation.
- To confirm the order, see Order Confirmation