Update Shipment Status

Konnect API reference (1.0.0)

Welcome to the Fynd Konnect API Reference, a resource designed for quickly testing and exploring the functionality offered by Fynd Konnect. This reference provides:

Schema Definitions: Clear, concise data models for requests and responses to facilitate debugging and prototyping API integrations
Try It Console: Interactive testing directly from the documentation, enabling real-time experimentation with endpoints, response examination, and setup validation
Endpoint Overview: A structured catalog of Fynd Konnect APIs (Authorization, Catalog, Pricing, Inventory, Orders, Returns) for streamlined discovery and usage

Dive into how Fynd Konnect can support operational and technical needs in a sandboxed, experimentation-friendly environment

Download OpenAPI description

konnect.json

konnect.yaml

Servers

Fynd Konnect [Sandbox]

https://fyndkonnect.konnect.uat.fyndx1.de/

Ginesys <> Konnect [Sandbox]

https://ginesys.konnect.uat.fyndx1.de/

Unicommerce <> Konnect [Sandbox]

https://unicommerce.konnect.uat.fyndx1.de/

Authorization

Provides endpoints for obtaining and managing authentication tokens Supports both Company-Level and Location-Level authorization modes, giving you fine-grained access control across multiple stores or warehouses
Integrate seamlessly with Fynd Konnect by exchanging your credentials for time-bound access tokens, ensuring secure interactions with all other APIs

Operations

Catalog

Lets a partner maintain and retrieve detailed product listings in the Fynd OMS Includes endpoints to fetch the total SKU count and specific product listings with pagination or SKU filters
Ideal for validating data synchronization, bulk updates, or verifying new product onboarding

Operations

Pricing

Offers a way to set or update the MRP and ESP for your SKUs on a per-location basis, ensuring pricing uniformity across your internal systems and the Fynd platform
Supports high-volume updates (up to 500 records) in one call, streamlining real-time price adjustments for flash sales, promotions, or omni-channel pricing consistency

Operations

Inventory

Enables real-time stock-level management in the Fynd OMS. Update inventory quantities for each SKU across multiple locations, ensuring that Fynd accurately reflects item availability. Prevent overselling or stockouts by syncing frequently
Maximum 500 records can be updated in a single request

Operations

Orders

Covers the entire end-to-end lifecycle of orders on Fynd, from initial retrieval through packing, dispatching, and final delivery. Includes:
- Fetching new or updated orders
- Cancellation of orders or specific items before invoicing
- Confirmation of orders in bulk
- Invoicing or credit note generation
- Make order pack and dispatch calls
- AWB and courier updates for self-ship scenarios
- Order status transitions for self-ship scenarios (bag_picked, delivery_done, etc.)
Maximum 20 records can be updated in a single request

Operations

Fetch Orders

Request

Retrieve orders filtered by Order Status, Ordering Channel, Date Range, or Location Code (when using company-level auth).
Useful to identify newly placed orders for fulfillment, manage different statuses in a consolidated environment, or Customer Returns by specifying orderStatus as RETURN_DELIVERED in parameters.
An Order can also be fetched by passing its shipment ID in parameters.

Query

orderIdstring

Unique shipment identifier

orderingChannelstring

Filter shipments by the sales channel (e.g., ECOMM, FYND)

orderStatusstringrequired

Filters orders by current status (CREATED, CONFIRMED, PROCESSING, etc.).

pageNumberinteger

Page number for paginated results

pageSizeinteger

Number of results per page

locationCodestring

Store or warehouse location code
If using Company-level auth, locationCode is mandatory

orderDateFromstring(date)

Filters orders from this date (dd-mm-yyyy)

orderDateTostring(date)

Filters orders up to this date (dd-mm-yyyy)

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'

Responses

Successful response

Bodyapplication/jsonArray [

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.

]

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
  }
]

Order Cancellation

Request

Cancel entire orders or specific items before invoicing. Handles partial or full cancellations when the order is still in a pre-invoiced state.

Bodyapplication/jsonrequiredArray [

orderIdstringrequired

Unique identifier for the order to be canceled

orderItemsArray of objects

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/cancel \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string",
      "orderItems": [
        {
          "orderItemId": "string",
          "quantity": 0,
          "reasonCode": "string"
        }
      ]
    }
  ]'

Responses

Order cancellation response

Bodyapplication/json

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Order Confirmation

Request

This endpoint enables the finalization of the order after any required cancellations for subsequent packing, invoicing, and dispatch flows.

Bodyapplication/jsonrequiredArray [

orderIdstringrequired

Unique identifier for the order being confirmed

orderItemsArray of objects

List of items to confirm within the order

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/confirm \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string",
      "orderItems": [
        {
          "orderItemId": "string",
          "quantity": 0
        }
      ]
    }
  ]'

Responses

Order confirmation response

Bodyapplication/json

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Update Invoice

Request

Provide invoice details, overwrite packaging dimensions, or push IRN to Fynd Commerce for B2B invoicing using this endpoint.

Note: To generate credit note for a customer return or an RTO, pass "invoiceType": "return"

Bodyapplication/jsonrequiredArray [

orderIdstringrequired

Shipment Id of the order to be invoiced

invoiceNumberstringrequired

Unique invoice reference number

invoiceTypestringrequired

Type of invoice (Either sale for the forward order invoice series or return for the customer return credit note)

invoiceQrCodestring

QR code data for the invoice

irnNumberstring

Invoice Reference Number for e-invoicing

signedInvoicestring

Digitally signed invoice data

ackNumberstring

Acknowledgment number from tax authority

ackDatestring

Date of acknowledgment receipt

orderItemsArray of objects

List of items included in the invoice

packagesArray of objects

Meta data for packaging if applicable; overwrites the existing package dimensions

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/invoiceUpdate \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string",
      "invoiceNumber": "string",
      "invoiceType": "string",
      "invoiceQrCode": "string",
      "irnNumber": "string",
      "signedInvoice": "string",
      "ackNumber": "string",
      "ackDate": "string",
      "orderItems": [
        {
          "orderItemId": "string",
          "quantity": 0,
          "imeiSerialNumber": [
            "string"
          ]
        }
      ],
      "packages": [
        {
          "packageId": "string",
          "packageLengthCm": 0,
          "packageWidthCm": 0,
          "packageHeightCm": 0,
          "packageWeightGms": 0
        }
      ]
    }
  ]'

Responses

Invoice update or credit note response

Bodyapplication/json

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Update AWB

Request

Add Air Waybill number and courier name for self-ship orders once they have physically shipped from the seller's warehouse.

Order: Update when the order is in the dp_assigned state on Fynd.
- Fetch such orders using the GET Orders endpoint with "orderStatus = PROCESSING")
Returns: Update in the return_dp_assigned state on Fynd.
- Fetch such returns using the GET Orders endpoint with "orderStatus = RETURN_PROCESSING")

Note: Set autoDispatch = true for automatic state transition from dp_assigned to bag_picked on Fynd in one step.

Bodyapplication/jsonrequiredArray [

awbNumberstringrequired

Air Way Bill number for the shipment

courierNamestringrequired

Courier partner's name

orderIdstringrequired

Unique identifier of the order

autoDispatchbooleanrequired

When true, auto-transitions order from dp_assigned → bag_picked state on Fynd OMS

Enumfalsetrue

]

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
    }
  ]'

Responses

Successful AWB update

Bodyapplication/json

dataobject

Response data regarding payload processing

metaobject

Metadata about the operation's result

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"
  }
}

Order Pack

Request

Marks unfulfilled orders as packed, readying them for dispatch.

Bodyapplication/jsonrequiredArray [

orderIdstring

Unique identifier for the order for which the order pack call needs to be pushed to Fynd

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/pack \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Responses

Order packing response

Bodyapplication/json

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Courier Details

Request

Retrieve courier information for specific orders.

Bodyapplication/jsonrequiredArray [

orderIdstring

Unique identifier for the order for which the courier details need to be fetched

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/courierDetails \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Responses

Courier details response

Bodyapplication/jsonArray [

courierNamestring

Name of the courier service provider

courierCodestring

Fynd unique code identifying the courier partner

awbNumberArray of strings

List of airway bill numbers for tracking

additionalInfostring

Any extra information about the shipment

orderIdstring

Shipment ID of the order for which the courier has been assigned

]

Response

application/json

[
  {
    "courierName": "FyndTest",
    "courierCode": "FyndTest",
    "awbNumber": [ … ],
    "additionalInfo": "You can add additional info here",
    "orderId": "17788083923861469968"
  },
  {
    "courierName": "FyndTest",
    "courierCode": "FyndTest",
    "awbNumber": [ … ],
    "additionalInfo": "You can add additional info here",
    "orderId": "17888083923861469000"
  }
]

Shipping Label

Request

Generate and retrieve shipping label PDFs for one or more orders. Requested post Pack stage to attach shipping labels to outgoing parcels.

Bodyapplication/jsonrequiredArray [

orderIdstring

Unique identifier for the order for which the shipping label need to be fetched

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/labels \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Responses

Returns shipping label PDF

Bodyapplication/pdf

string(pdf)

Response

application/pdf

As a response, the shipping label PDF will be the output.

Customer Invoice

Request

Generate and retrieve a customer invoice (PDF) for orders ready for dispatch.

Bodyapplication/jsonrequiredArray [

orderIdstring

Unique identifier for the order for which the invoice needs to be fetched from Fynd

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/invoice \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Responses

Returns a customer invoice PDF

Bodyapplication/pdf

string(binary)

Response

application/pdf

As a response, the customer invoice PDF will be the output.

Order Dispatch

Request

Mark the order(s) as dispatched; indicating it has been handed over to the delivery partner.

Bodyapplication/jsonrequiredArray [

orderIdstring

Unique identifier for the order for which the order dispatch call needs to be pushed to Fynd

orderItemsArray of objects

]

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/dispatch \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string",
      "orderItems": [
        {
          "orderItemId": "string",
          "quantity": 0
        }
      ]
    }
  ]'

Responses

Order dispatch response

Bodyapplication/json

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Update Shipment Status

Request

Enables the updating of shipment statuses for self-ship orders post-dispatch. Allowed order status flow on Fynd for self-ship orders/returns:

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

Bodyapplication/jsonrequiredArray [

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

Additional metadata for the update

]

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"
      }
    }
  ]'

Responses

Successful shipment status update

Bodyapplication/json

dataobject

Response data regarding payload processing

metaobject

Metadata about the operation's result

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"
  }
}

Returns

Manages the reverse and RTO (Return to Origin) journeys for your orders:
- Fetch returns by using GET Orders endpoint with RETURN_DELIVERED as the order status
- Quality Check acceptance after items are returned to the seller
- Credit Note issuance for returns or RTO using the PUT Update Inventory endpoint with "invoiceType: return"
All reverse processes remain in sync with Fynd OMS
Maximum 20 records can be updated in a single request

Operations

Konnect API reference (1.0.0)

Authorization

Catalog

Pricing

Inventory

Orders

Fetch Orders

Request

Responses

Was this helpful?

Order Cancellation

Request

Responses

Was this helpful?

Order Confirmation

Request

Responses

Was this helpful?

Update Invoice

Request

Responses

Was this helpful?

Update AWB

Request

Responses

Was this helpful?

Order Pack

Request

Responses

Was this helpful?

Courier Details

Request

Responses

Was this helpful?

Shipping Label

Request

Responses

Was this helpful?

Customer Invoice

Request

Responses

Was this helpful?

Order Dispatch

Request

Responses

Was this helpful?

Update Shipment Status

Request

Responses

Was this helpful?

Returns