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
Unique shipment identifier. If provided, none of the other parameters need to be filled and an order can be fetched by its shipment ID
Filter shipments by the sales channel (e.g., ECOMM, FYND)
Filters orders by current status
Page number for paginated results
Number of results per page
Store or warehouse location code. If Company-level auth is being used then locationCode field 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.
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=CREATED&pageNumber=0&pageSize=0&locationCode=string&orderDateFrom=2019-08-24&orderDateTo=2019-08-24' \
-H 'x-access-token: YOUR_API_KEY_HERE'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 |
|
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