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
- 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=string&pageNumber=0&pageSize=0&locationCode=string&orderDateFrom=2019-08-24&orderDateTo=2019-08-24' \
-H 'x-access-token: YOUR_API_KEY_HERE'