Use this endpoint to update an order's status through various self-ship milestones in Fynd OMS. To learn more about Konnect Self Ship, check out Fynd Konnect Self Ship via Aggregators
Request Type:
PUT
Scheme:HTTPS
Endpoint:https://{{host}}/oms/v3/shipment/status
Try out Fynd Konnect's Update Shipment Status Endpoint
Common Request Header
| Header | Mandatory | Description |
|---|---|---|
x-access-token | Yes | The token required for authenticated calls to Fynd Konnect. |
Important Considerations
- Shipment statuses can only be pushed to Fynd for orders on the self-ship model, which can be identified by the
"is_self_ship: true"flag in order or return responses from Fynd OMS. - Partners can update courier details for up to 20 orders in a single API call.
- Shipment status updates are only applicable to the following order states on Fynd:
- Forward flow:
dp_assigned→bag_picked→delivery_done - Return flow:
return_dp_assigned→return_bag_in_transit→return_bag_delivered - RTO flow:
dp_assigned→bag_picked→rto_bag_deliveredThese should be the final courier assignments.
- Forward flow:
- Setting
"autoDispatch": "true"removes the need to push the order tobag_pickedusing Update Shipment Status, and only thedelivery_donecall needs to be passed to Fynd.
orderIdstringrequired
Identifier of the order to update
orderStatusstringrequired
Next order status
Enum"bag_picked""delivery_done""rto_bag_delivered""return_bag_in_transit""return_bag_delivered"
metaobject
dataobject
Response data regarding payload processing
metaobject
Metadata about the operation's result
- Fynd Konnect [Sandbox]https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/status
curl -i -X PUT \
https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/status \
-H 'Content-Type: application/json' \
-H 'x-access-token: YOUR_API_KEY_HERE' \
-d '[
{
"orderId": "string",
"orderStatus": "bag_picked",
"meta": {
"remark": "string",
"reasonCode": 0,
"dpLocation": "string",
"promised_delivery_date": "string",
"estimated_delivery_date": "string"
}
}
]'