PACKED to READY_TO_DISPATCH

The Shipment Dispatch API marks order items inside shipment as “Ready to Dispatch” and communicates to the logistics partners that the shipment is ready for pick up.

Request - v3 API

POST https://api.flipkart.net/sellers/v3/shipments/dispatch

Request Body Schema (v3)

const shipmentId = {
	type: 'string',
};

const shipmentIds = {
	type: 'array',
	minItems: 1,
	maxItems: 25,
    items: shipmentId,
};

const locationId = {
	type: 'string',
};

const DispatchShipmentRequest = {
    type: "object",
    properties: {
        /**
         * List of shipment ids
         * Array[string] - minLength: 1, maxLength: 25
        */
        shipmentIds: shipmentIds,
        /**
         * Seller’s location id from where item is dispatched
         * String
        */
        locationId: locationId,
    },
    required: ["shipmentIds", "locationId"],
}

Request Body Example (v3)

{
    "rtdBody":  {
        "shipmentIds": [
          "df3d0605-06ef-4602-aacb-64f653e2e048"
        ],
        "locationId": "LOCbba44916f16b474da588ed9b28768c43"
    }
}

Response Body Schema (v3)

const Dimension = {
    type: "object",
    properties: {
        length: { type: "number" },
        breadth: { type: "number" },
        height: { type: "number"},
    },
}

const NotionalValue = {
    type: "object",
    properties: {
        amount: { type: "number", minimum: 0 },
        unit: { type: "string", enum: ['PERCENTAGE', 'INR'] },
    },
}

const Handling = {
    type: "object",
    properties: {
        fragile: { type: "boolean" },
    },
}

const Package = {
    type: "object",
    properties: {
        id: { type: "string" },
        name: { type: "string" },
        dimensions: Dimension,
        weight: { type: "number"},
        notional_value: NotionalValue,
        description: { type: "string"},
        handling: Handling,
    },
}

const SubShipment = {
    type: "object",
    properties: {
        subShipmentId: { type: "string" },
        packages: { type: "array", items: Package }
    },
}

const PriceComponent = {
    type: "object",
    properties: {
        sellingPrice: { type: "number" },
        totalPrice: { type: "number" },
        shippingCharge: { type: "number" },
        customerPrice: { type: "number"},
        flipkartDiscount: { type: "number" },
    },
}

const OrderItem = {
    type: "object",
    properties: {
        orderItemId: { type: "string" },
        orderId: { type: "string" },
        cancellationGroupId: { type: "string" },
        orderDate: { type: "string" },
        cancellationDate: { type: "string"},
        paymentType: { type: "string", enum: ['COD', 'PREPAID'] },
        status: { type: "string", enum: [ APPROVED, PACKING_IN_PROGRESS, FORM_FAILED, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, RETURN_REQUESTED, RETURNED, SHIPPED, DELIVERED, COMPLETED ] },
        cancellationReason: { type: "string"},
        cancellationSubReason: { type: "string"},
        courierReturn: { type: "boolean" },
        quantity: { type: "integer" },
        fsn: { type: "string"},
        sku: { type: "string"},
        listingId: { type: "string"},
        hsn: { type: "string"},
        title: { type: "string"},
        packageIds: { type: "array", items: "string" },
        priceComponents: PriceComponent,
        serviceProfile: { type: "string", enum: [ Flipkart_Fulfilment, Seller_Fulfilment, Smart_Fulfilment, FBF, NON_FBF, FBF_LITE ] },
        is_replacement: { type: "boolean"},
    },
}

const Form = {
    type: "object",
    properties: {
        name: { type: "string" },
        link: { type: "string" },
        automated: { type: "boolean" },
    },
}

const Shipment = {
    type: "object",
    properties: {
        shipmentId: { type: "string" },
        dispatchByDate: { type: "string" },
        dispatchAfterDate: { type: "string" },
        updatedAt: { type: "string"},
        locationId: { type: "string"},
        hold: { type: "boolean"},
        mps: { type: "boolean"},
        packagingPolicy: { type: "string" },
        subShipments: { type: "array", items: SubShipment },
        orderItems: { type: "array", items: OrderItem },
        forms: { type: "array", items: Form },
        shipmentType: { type: "string" },
    },
}

const ShipmentStatusResponse = {
    type: "object",
    properties: {
        shipments: { type: "array", items: Shipment },
    },
    required: ["shipments"],
}

Success Response Example (v3)

// status: 200
{
  "shipments": [
    {
      "shipmentId": "df3d0605-06ef-4602-aacb-64f653e2e048",
      "status": "SUCCESS"
    }
  ]
}

Possible Error Response Codes (v3)

Request - Dashboard APIs

Request

POST https://seller.flipkart.com/napi/shipments/rtsV2?sellerId=${sellerId}

Request Params

Required sellerId - Seller's unique ID

Request Body Schema

const requestBody = {
    type: "object",
    properties: {
        rtdRequestBody: { type: "array", items: {type: "string"} },
    },
    required: ["rtdRequestBody"],
}

Request Body Sample

{
  "rtdRequestBody": ['2f14a546-626d-40eb-86d8-1dcb2f615174']
}

Response Sample

[
  {
    "errorReponse": false,
    "isPickUpAfterDatePresent": true,
    "pickupAfterDate": "2022-08-29T12:00:00.000+05:30",
    "shipmentId": "2f14a546-626d-40eb-86d8-1dcb2f615174",
    "succeeded": true
  }
]