Konnect Self-Ship: Update AWB

Use the Update AWB endpoint to assign Air Waybill (AWB) numbers and courier details for self-ship orders 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/awb

Try out Fynd Konnect's Update AWB Endpoint

Common Request Header

Header	Mandatory	Description
`x-access-token`	Yes	The token required for authenticated calls to Fynd Konnect.

Important Considerations

AWB 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 update courier details for up to 20 orders in a single API call
AWB updates are only accepted for:
- Orders in the dp_assigned state (fetch using Fetch Orders with orderStatus = "PROCESSING")
- Returns in the return_dp_assigned state (fetch using Fetch Returns with orderStatus = "RETURN_PROCESSING")
Only push courier details when the order has actually been shipped from the warehouse, as these should be the final courier assignments
Setting "autoDispatch": "true" enables automatic state transitions:
- For orders (not applicable for returns), this automatically moves the state from dp_assigned to bag_picked on Fynd
- Orders in bag_picked state can be fetched using orderStatus = "TRANSIT"
- Use this flag to skip making sequential API calls after pushing courier details

Body

awbNumberstringrequired

Air Waybill (AWB) number for the shipment

courierNamestringrequired

Courier partner's name

orderIdstringrequired

Unique identifier of the order or return

autoDispatchbooleanrequired

When true, auto-transitions the order from dp_assigned to bag_picked on Fynd OMS

Enumfalsetrue

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/awb \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "awbNumber": "string",
      "courierName": "string",
      "orderId": "string",
      "autoDispatch": false
    }
  ]'

Response

application/json

{
  "data": {
    "payload_count": 5,
    "success_count": 5,
    "failed_count": 0,
    "errors": []
  },
  "meta": {
    "trace_id": "766199ba-df9a-11ef-bc17-6b1b0369fe3a",
    "time": "2025-01-31T11:43:18.672+05:30",
    "status": "SUCCESS"
  }
}

Next Steps

After assigning AWB and courier, keep updating milestone changes using Update Shipment Status. For example, to mark bag_picked, delivery_done, return_bag_in_transit, return_bag_delivered, or rto_bag_delivered