Skip to content

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

HeaderMandatoryDescription
x-access-tokenYesAccess token used for authenticating API requests to Fynd Konnect
Best Practices

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


Query

orderIdstring

Unique shipment identifier. If provided, none of the other parameters need to be filled and an order can be fetched by its shipment ID

orderingChannelstring

Filter shipments by the sales channel (e.g., ECOMM, FYND)

orderStatusstringrequired

Filters orders by current status

Enum"CREATED""CANCELLED""CONFIRMED""PROCESSING""COMPLETED""TRANSIT""HANDED_OVER_TO_CUSTOMER""DELIVERED""RETURN_PROCESSING""RETURN_DELIVERED"
pageNumberinteger

Page number for paginated results

pageSizeinteger

Number of results per page

locationCodestring

Store or warehouse location code. If Company-level auth is being used then locationCode field is mandatory

orderDateFromstring(date)

Filters orders from this date (dd-mm-yyyy)

orderDateTostring(date)

Filters orders up to this date (dd-mm-yyyy)

Want to fetch better results?

Use query parameters like orderStatus, pageNumber, and locationCode (only required in the case of company-level auth) to refine the results.

Success Resposne

idstring

Unique shipment identifier

forwardIdstring

Forward shipment ID (same as id for forward orders, a unique shipment id is created for returns and cancellations)

marketplaceOrderIdstring

Marketplace-specific order identifier

marketplaceReturnIdstring or null

Marketplace-specific return identifier (null for forward orders)

marketplaceInvoiceNumberstring or null

Marketplace-provided invoice number

shippingAddressobject

Customer's shipping address details

billingAddressobject

Customer's billing primary address

multiPackShipmentboolean

Indicates if the shipment contains multiple packages

packagesArray of objects

Package dimensions and weight information

fulfillmentTypestring

Fulfillment type

sellerInvoicedboolean

Indicates if the seller has generated an invoice

courierNamestring or null

Name of the assigned courier partner

courierCodestring or null

Courier partner code

awbNumberArray of strings

List of Air Waybill numbers for tracking

additionalInfostring

Additional information or notes about the order

orderPriceobject

Order pricing details

orderItemsArray of objects(OrderItem)

List of items in the order

orderStatusstring

Current status of the entire order (e.g., CREATED, CONFIRMED, PROCESSING, DELIVERED)

orderDatestring(date-time)

Timestamp when the order was placed

modifiedDatestring

Last status modified timestamp of the shipment

paymentTypestring

Payment method (e.g., COD, Prepaid)

taxExemptedboolean

Indicates if the shipment is tax-exempted

gstinstring or null

GST Identification Number (IRN) for B2B orders

packAfterDatestring or null

Date after which the order should be packed

packByDatestring or null

Date by which the order must be packed

pickUpSlotsArray of objects

Available pickup time slots

orderingChannelstring

Sales channel name for webstore or marketplace

labelPdfUrlstring or null

URL for the shipping label PDF (A4 size)

labelA6PdfUrlstring or null

URL for the shipping label PDF (A6 size)

purchaseOrderPdfUrlstring or null

URL for the purchase order PDF

invoiceNumberstring or null

Invoice number generated for the shipment either by Fynd or the Seller

returnInvoiceNumberstring or null

Credit note/return invoice number generated for the shipment either by Fynd or the Seller

irnNumberstring or null

Invoice Reference Number (IRN) for e-invoicing

invoiceQrCodestring or null

QR code data for the invoice

signedInvoicestring or null

Digitally signed invoice data

orderBusinessTypestring

Business type (e.g., B2C, B2B)

lockStatusboolean

Indicates if the order is locked for processing

fulfillmentPrioritystring or null

Priority level for order fulfillment

journeyTypestring

Order journey type (e.g., forward, return)

invoiceGenerationDatestring(date-time)

Timestamp when the invoice was generated

shipmentTagsArray of strings

Tags or labels associated with the shipment

slastring

Service Level Agreement - Order processing Turn Around Time (TAT)

cformProvidedboolean

Indicates if C-Form has been provided for inter-state sales

channel_bag_idstring

Channel-specific bag identifier

channel_shipment_idstring

Channel-specific shipment identifier

A4invoicePdfUrlstring or null

URL for the invoice PDF (A4 size)

A6invoicePdfUrlstring or null

URL for the invoice PDF (A6 size)

is_returnlessboolean

Indicates if the order is non-returnable

is_self_shipboolean

Indicates if this is a self-ship order (seller manages logistics)

API Call Example

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'

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
  • Covers orders placed via the merchant's Fynd StoreOS storefront.
FYND
  • Channel orders placed directly via GoFynd's online platform.
ECOMM
  • Indicates seller website orders placed on Fynd Commerce.
AMAZON_MLF
  • Indicates Amazon Multi-Location Fulfillment orders. Suitable if a brand leverages Amazon's warehousing but still wants to track orders in Fynd OMS.
MYNTRA_IN
  • Integrates orders from Myntra India's fashion marketplace.
UNIKET
  • Uniket is a B2B footwear marketplace owned by Fynd. Typical for sellers focusing on wholesale or large-scale distribution.
TATACLIQ_IN
  • Orders from Tata CLiQ; an Indian e-commerce by Tata Group.
FLIPKARTASSURED
  • A specialized subset of Flipkart (F-Assured) orders marked for high quality and quick deliveries.
AJIO_VMS
  • Reflects orders from AJIO. Channel used for multi-brand apparel or lifestyle segments.
TATACLIQ_LUXURY
  • Signifies premium or luxury items via Tata CLiQ's upscale segment.
NYKAA_FASHION
  • Orders from the Nykaa Fashion marketplace (apparel and accessories).
NYKAA
  • Standard Nykaa e-commerce platform, typically cosmetics and lifestyle products.
TRELL
  • Social commerce platform Trell, often lifestyle or influencer-driven.
MAGICPIN
  • Magicpin, a local discovery and rewards-based commerce solution which joined the ONDC platform for localized food delivery.
SHOPIFY_IN
  • Identifies orders from Shopify India webstores.
FLIPKART
  • General Flipkart channel orders.
JIOMART
  • Reliance Retail's JioMart (grocery and general e-commerce).
FY_NEXUS
  • Reserved for sellers selling through Nexus 247 marketplace.

Order Status

By specifying the orderStatus query parameter, you can filter orders based on their lifecycle stage within Fynd OMS.

Status Description
CREATED
  • Newly placed orders on Fynd. Typically in the placed or store_reassigned state in the Fynd OMS.
CONFIRMED
  • Shipments where all items are in bag_confirmed in Fynd OMS. Ready for further actions like invoicing and courier assignment.
PROCESSING
  • Orders in bag_invoiced or dp_assigned state in Fynd OMS. Typically post-confirmation, pre-dispatch.
COMPLETED
  • Order fulfillment is complete. Orders in bag_packed or bag_not_picked states on Fynd OMS.
TRANSIT
  • Order en route to customer. Orders in bag_picked states on Fynd OMS.
HANDED_OVER_TO_CUSTOMER
  • Goods delivered in-person or picked up at the store by the customer. Orders in handed_over_to_customer state on Fynd OMS.
DELIVERED
  • Orders successfully delivered at the customer address. Orders in delivery_done state on Fynd OMS.
RETURN_PROCESSING
  • Return or RTO process initiated, but not yet delivered back to the seller. Returns in return_initiated or return_dp_assigned states on Fynd.
RETURN_DELIVERED
  • Fetches customer returns (bag in return_bag_delivered on Fynd) or RTO bags (bag in rto_bag_delivered on Fynd) delivered to the seller warehouse.
RETURN_COMPLETED
  • A return or RTO accepted by the seller after QC.
CANCELLED
  • Order (either partially or complete) canceled by user, Fynd, or the seller.
CREDIT_NOTE_GENERATED
  • Credit note generation post return completion.
Next Steps