Konnect Self-Ship: Update Shipment Status

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_delivered These should be the final courier assignments.
Setting "autoDispatch": "true" removes the need to push the order to bag_picked using Update Shipment Status, and only the delivery_done call needs to be passed to Fynd.

Body

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

Success Response

dataobject

Response data regarding payload processing

metaobject

Metadata about the operation's result

API Call Example

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",
        "dpLocation": "string",
        "promised_delivery_date": "string",
        "estimated_delivery_date": "string"
      }
    }
  ]'

Response

application/json

{
  "data": {
    "payload_count": 2,
    "success_count": 2,
    "failed_count": 0,
    "errors": []
  },
  "meta": {
    "trace_id": "db6dfa6b-df9a-11ef-bc17-2fcac2e9681c",
    "time": "2025-01-31T11:46:07.751+05:30",
    "status": "SUCCESS"
  }
}