Order by ID

The Order by ID API allows retrieval of a specific order or shipment based on its unique shipment identifier. This is useful for obtaining detailed information about a single order, including its current status, shipment details, lock status, and associated customer and logistics documents.

Request Type: GET
Scheme: HTTPS
Endpoint: https://{{host}}/oms/v3/shipment

Try out Fynd Konnect's Order by ID Endpoint

Common Request Header

Header	Mandatory	Description
`x-access-token`	Yes	Access token used for authenticating API requests to Fynd Konnect.

Query

orderIdstringrequired

Fetch a particular order by its shipment identifier

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=string&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
  }
]