Order Management API Reference

API Test Environment

  • To access and test the self-serve APIs in sandbox, click here.
  • To access and test the Order Management pull APIs in sandbox, click here.

You can use the following APIs to create, receive, send, and work with various shipment and order related details.

POST/v3/shipments/filter/

Description - The Search Shipments API searches shipments using specific filters. It gets shipment details based on the order date, dispatch date, shipment states, and seller SKU ID. The first call to the Search API returns a finite number of results based on the pageSize value. Calling the URL returned in the next Page URL field of the response gets the subsequent pages of the search result. The response of the Search API contains a list of shipments and their sub-shipments, to be packed together in one shipment, for which only one label is generated.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/filter/

Request Body Parameters filter

Parameter/Attribute Type Requirement Description
type String Mandatory Types of Dispatch can be preDispatch or postDispatch or cancelled
states List<String> Optional Filter shipments based on a comma separated list of valid shipment states. Possible values:APPROVED, PACKING_IN_PROGRESS, PACKED, FORM_FAILED, READY_TO_DISPATCH, SHIPPED, DELIVERED
sku List<String> Optional Filter orders based on a comma separated list of seller SKUs
serviceProfiles String Optional This field defaults to NON_FBF
mps Boolean Optional Multi pack shipment accepts True or False
sources String Mandatory Point of origin of the shipment
locationId String Mandatory Id which refers to seller’s dispatch location
cancellationType String Mandatory if Filter Type is Cancel Describes where the Cancellation was initiated. For example if the Marketplace cancelled then this value is MarketPlace Cancellation.
  • orderDate:
  • from
  • to
 String Optional Filter based on shipments placed within the selected date range, where the date strings are in ISO format
  • dispatchAfterDate:
  • from
  • to
 String Optional Filter based on shipments placed within the selected date range, where the date strings are in ISO format
  • dispatchByDate:
  • from
  • to
 String Optional Filter based on shipments placed within the selected date range, where the date strings are in ISO format
  • cancellationDate:
  • from
  • to
 String Optional Filter based on shipments placed within the selected date range, where the date strings are in ISO format

Request Body Parameter: pagination

Parameter Type Requirement Description
pageSize Numeric Optional Number of search results to display in one page. Maximum size is 20

Request Body Parameter: sort

Parameter Type Requirement Description
field ISO String Optional Sort results by dispatchByDate
order String Optional Sort results by desc or asc

Validations

pageSize: Value between 1 and 20
states: Options are APPROVED, PACKED, READY_TO_DISPATCH, CANCELLED
filter: All filters are optional
sort field: Can be orderDate or dispatchByDate
For postDispatch, request must be sent separately for SELF and NORMAL shipments. It will be modified to allow both NORMAL and SELF shipments in same request payload, at a later date
Valid values for ``cancellationType`` are ``marketplaceCancellation``, ``sellerCancellation`` and ``buyerCancellation``
State filed value depends on the ‘Type’ attribute.If the filter type is Cancel, the state has to be’Cancelled’.

Note

  • Provides only those orders that are fulfilled based on the seller’s fulfillment service. Flipkart Advantage (FA) orders are not shown.
  • The default sort order is by dispatchByDate (to be marked “Ready to Dispatch”).
  • If the date strings do not contain timezone information, it is assumed as IST.

Response Body Parameters:

Parameter/Attribute Type Description
nextPageUrl String Url for accessing the next page
hasMore Boolean A flag to indicate whether there are more search results in the next page
shipments List List of Shipments
shipmentId String Primary identifier for a specific shipment.
dispatchByDate ISO String Date by which the order items needs to be dispatched by the seller
dispatchAfterDate ISO String Date after which the order items needs to be processed by the seller
updatedAt ISO String Timestamp of the last update for a particular order item
hold Boolean Flag True or False for Shipment Verification Process.
locationId String Id which refers to seller’s dispatch location
orderItems List Comma separated list of Order Items
orderItems. fsn String Flipkart Serial Number that identifies the order item.
orderItems. quantity Number Number of units of the item ordered.
orderItems. orderId String System generated orderId for an order within a shipment.
orderItems. orderItemId String System generated id for an item within an order.
orderItems. listingId String Product Listing Id
orderItems. sku String Seller’s store keeping unit where the item is available
orderItems. cancellationGroupId String Refers to the group of order items which will be cancelled.
orderItems. isReplacement Boolean True or False indicating if the order item replaces another order item.
orderItems. priceComponents. sellingPrice Float Product price listed by the seller. This value can be less than or equal to the MRP.
orderItems. priceComponents. totalPrice Float The price paid by the customer for this order item (customerPrice``+ ``shippingCharge)
orderItems. priceComponents. shippingCharge Float Fees charged for this order item of shipment.
orderItems. priceComponents. customerPrice Float The price at which buyer bought the order item from the Website (sellingPrice- promotionDiscount)
orderItems. priceComponents. emi Float EMI component for a particular order item id
orderItems. priceComponents. flipkartDiscount Float Flipkart discount for the particular order item id
orderItems. orderDate ISO String Date on which the order is placed.
orderItems. cancellationDate ISO String Date when the order item is cancelled.
orderItems. cancellationReason String Reason for the cancellation
orderItems. cancellationSubReason String Sub reason chosen for cancellation. In case of seller cancellation below are the valid sub reason(cannot_procure_item,not_enough_inventory,b2b_order)
orderItems. courierReturn boolean True or False indicating if courier return created for the order item.
orderItems. status String The current order processing status. Possible values:APPROVED, PACKING_IN_PROGRESS, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, SHIPPED, DELIVERED, RETURN_REQUESTED, RETURNED
orderItems. packageIds List<String> List of packages to which the order item is associated
forms List<Forms> List of forms associated with the shipment
forms. name String Name of the for associated with the shipment.
forms. link String Link to the Government portal for where particular form can be generated.
forms. automated boolean True or False indicating Flipkart generated form for the mentioned form.
forms. status String Indicates status of form generation. Status can be one of the below (NOT-CREATED, IN-PROGRESS, COMPLETED and FAILED)
subShipments List List of sub shipments associated with a shipment
subShipments. subShipmentId String Primary identifier for a specific sub shipment.
subShipments. packages List List of packages inside one sub shipment
subShipments. packageId String Primary identifier for a specific package
subShipments. quantity Integer Quantity of sub shipments
subShipments. packageTitle String Title of the package
subShipments. packageSku String SKU of the package

Possible Error Response Codes

Error Codes Reason for Error
INVALID_REQUEST_PAGE_SIZE Validation failure of the requested pageSize value
INVALID_REQUEST_JSON JSON parsing failure of the request
INVALID_DATE_FORMAT Parsing failure of the from or to dates

GET/v3/shipments?shipmentIds={}

Description - The Get by ShipmentIds API gets the shipment detail by shipmentId. It returns the shipmentDetails with the specified orderItemId and all its sub shipments and packages.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments?shipmentIds={}

Request Header Parameters

Parameter Requirement Description
shipmentIds Mandatory Comma separated shipment ids

Response Body Parameters

Parameter/Attribute Type Description
shipmentId String Primary identifier for a specific shipment.
dispatchByDate ISO String Date by which the order items needs to be dispatched by the seller
dispatchAfterDate ISO String Date after which the order items needs to be processed by the seller
updatedAt ISO String Timestamp of the last update for a particular order item
hold Boolean Flag True or False for Shipment Verification Process.
locationId String Id which refers to seller’s dispatch location
orderItems List Comma separated list of Order Items
orderItems. fsn String Flipkart Serial Number that identifies the order item.
orderItems. quantity Number Number of units of the item ordered.
orderItems. orderId String System generated orderId for an order within a shipment.
orderItems. orderItemId String System generated id for an item within an order.
orderItems. listingId String Product Listing Id
orderItems. sku String Seller’s store keeping unit where the item is available
orderItems. cancellationGroupId String Refers to the group of order items which will be cancelled.
orderItems. isReplacement Boolean True or False indicating if the order item replaces another order item.
orderItems. priceComponents. sellingPrice Float Product price listed by the seller. This value can be less than or equal to the MRP.
orderItems. priceComponents. totalPrice Float The price paid by the customer for this order item (customerPrice``+ ``shippingCharge)
orderItems. priceComponents. shippingCharge Float Fees charged for this order item of shipment.
orderItems. priceComponents. customerPrice Float The price at which buyer bought the order item from the Website (sellingPrice- promotionDiscount)
orderItems. priceComponents. emi Float EMI component for a particular order item id
orderItems. priceComponents. flipkartDiscount Float Flipkart discount for the particular order item id
orderItems. orderDate ISO String Date on which the order is placed.
orderItems. cancellationDate ISO String Date when the order item is cancelled.
orderItems. cancellationReason String Reason for the cancellation
orderItems. cancellationSubReason String Sub reason chosen for cancellation. In case of seller cancellation below are the valid sub reason(cannot_procure_item,not_enough_inventory,b2b_order)
orderItems. courierReturn boolean True or False indicating if courier return created for the order item.
orderItems. status String The current order processing status. Possible values:APPROVED, PACKING_IN_PROGRESS, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, SHIPPED, DELIVERED, RETURN_REQUESTED, RETURNED
orderItems. packageIds List<String> List of packages to which the order item is associated
forms List<Forms> List of forms associated with the shipment
forms. name String Name of the for associated with the shipment.
forms. link String Link to the Government portal for where particular form can be generated.
forms. automated boolean True or False indicating Flipkart generated form for the mentioned form.
forms. status String Indicates status of form generation. Status can be one of the below (NOT-CREATED, IN-PROGRESS, COMPLETED and FAILED)
subShipments List List of sub shipments associated with a shipment
subShipments. subShipmentId String Primary identifier for a specific sub shipment.
subShipments. packages List List of packages inside one sub shipment
subShipments. packageId String Primary identifier for a specific package
subShipments. quantity Integer Quantity of sub shipments
subShipments. packageTitle String Title of the package
subShipments. packageSku String SKU of the package

Validations

shipmentIds: should be valid shipment ids for this seller

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting forms for the shipment

GET/v3/shipments?orderItemIds={}

Description - The Get by ShipmentIds API gets the shipment detail by orderItemId. It returns the shipmentDetails with the specified orderItemId and all its sub shipments and packages.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments?orderItemIds={}

Request Header Parameters

Parameter Requirement Description
orderItemIds Mandatory Comma separated order item ids

Response Body Parameters

Parameter/Attribute Type Description
shipmentId String Primary identifier for a specific shipment.
dispatchByDate ISO String Date by which the order items needs to be dispatched by the seller
dispatchAfterDate ISO String Date after which the order items needs to be processed by the seller
updatedAt ISO String Timestamp of the last update for a particular order item
hold Boolean Flag True or False for Shipment Verification Process.
locationId String Id which refers to seller’s dispatch location
orderItems List Comma separated list of Order Items
orderItems. fsn String Flipkart Serial Number that identifies the order item.
orderItems. quantity Number Number of units of the item ordered.
orderItems. orderId String System generated orderId for an order within a shipment.
orderItems. orderItemId String System generated id for an item within an order.
orderItems. listingId String Product Listing Id
orderItems. sku String Seller’s store keeping unit where the item is available
orderItems. cancellationGroupId String Refers to the group of order items which will be cancelled.
orderItems. isReplacement Boolean True or False indicating if the order item replaces another order item.
orderItems. priceComponents. sellingPrice Float Product price listed by the seller. This value can be less than or equal to the MRP.
orderItems. priceComponents. totalPrice Float The price paid by the customer for this order item (customerPrice``+ ``shippingCharge)
orderItems. priceComponents. shippingCharge Float Fees charged for this order item of shipment.
orderItems. priceComponents. customerPrice Float The price at which buyer bought the order item from the Website (sellingPrice- promotionDiscount)
orderItems. priceComponents. emi Float EMI component for a particular order item id
orderItems. priceComponents. flipkartDiscount Float Flipkart discount for the particular order item id
orderItems. orderDate ISO String Date on which the order is placed.
orderItems. cancellationDate ISO String Date when the order item is cancelled.
orderItems. cancellationReason String Reason for the cancellation
orderItems. cancellationSubReason String Sub reason chosen for cancellation. In case of seller cancellation below are the valid sub reason(cannot_procure_item,not_enough_inventory,b2b_order)
orderItems. courierReturn boolean True or False indicating if courier return created for the order item.
orderItems. status String The current order processing status. Possible values:APPROVED, PACKING_IN_PROGRESS, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, SHIPPED, DELIVERED, RETURN_REQUESTED, RETURNED
orderItems. packageIds List<String> List of packages to which the order item is associated
forms List<Forms> List of forms associated with the shipment
forms. name String Name of the for associated with the shipment.
forms. link String Link to the Government portal for where particular form can be generated.
forms. automated boolean True or False indicating Flipkart generated form for the mentioned form.
forms. status String Indicates status of form generation. Status can be one of the below (NOT-CREATED, IN-PROGRESS, COMPLETED and FAILED)
subShipments List List of sub shipments associated with a shipment
subShipments. subShipmentId String Primary identifier for a specific sub shipment.
subShipments. packages List List of packages inside one sub shipment
subShipments. packageId String Primary identifier for a specific package
subShipments. quantity Integer Quantity of sub shipments
subShipments. packageTitle String Title of the package
subShipments. packageSku String SKU of the package

Validations

orderItemIds: should be valid order item ids for this seller

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting forms for the shipment

GET/v3/shipments?orderIds={}

Description - The Get by ShipmentIds API gets the shipment detail by orderId. It returns the shipmentDetails with the specified orderItemId and all its sub shipments and packages.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments?orderIds={}

Request Header Parameters

Parameter Requirement Description
orderIds Mandatory Comma separated order ids

Response Body Parameters

Parameter/Attribute Type Description
shipmentId String Primary identifier for a specific shipment.
dispatchByDate ISO String Date by which the order items needs to be dispatched by the seller
dispatchAfterDate ISO String Date after which the order items needs to be processed by the seller
updatedAt ISO String Timestamp of the last update for a particular order item
hold Boolean Flag True or False for Shipment Verification Process.
locationId String Id which refers to seller’s dispatch location
orderItems List Comma separated list of Order Items
orderItems. fsn String Flipkart Serial Number that identifies the order item.
orderItems. quantity Number Number of units of the item ordered.
orderItems. orderId String System generated orderId for an order within a shipment.
orderItems. orderItemId String System generated id for an item within an order.
orderItems. listingId String Product Listing Id
orderItems. sku String Seller’s store keeping unit where the item is available
orderItems. cancellationGroupId String Refers to the group of order items which will be cancelled.
orderItems. isReplacement Boolean True or False indicating if the order item replaces another order item.
orderItems. priceComponents. sellingPrice Float Product price listed by the seller. This value can be less than or equal to the MRP.
orderItems. priceComponents. totalPrice Float The price paid by the customer for this order item (customerPrice``+ ``shippingCharge)
orderItems. priceComponents. shippingCharge Float Fees charged for this order item of shipment.
orderItems. priceComponents. customerPrice Float The price at which buyer bought the order item from the Website (sellingPrice- promotionDiscount)
orderItems. priceComponents. emi Float EMI component for a particular order item id
orderItems. priceComponents. flipkartDiscount Float Flipkart discount for the particular order item id
orderItems. orderDate ISO String Date on which the order is placed.
orderItems. cancellationDate ISO String Date when the order item is cancelled.
orderItems. cancellationReason String Reason for the cancellation
orderItems. cancellationSubReason String Sub reason chosen for cancellation. In case of seller cancellation below are the valid sub reason(cannot_procure_item,not_enough_inventory,b2b_order)
orderItems. courierReturn boolean True or False indicating if courier return created for the order item.
orderItems. status String The current order processing status. Possible values:APPROVED, PACKING_IN_PROGRESS, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, SHIPPED, DELIVERED, RETURN_REQUESTED, RETURNED
orderItems. packageIds List<String> List of packages to which the order item is associated
forms List<Forms> List of forms associated with the shipment
forms. name String Name of the for associated with the shipment.
forms. link String Link to the Government portal for where particular form can be generated.
forms. automated boolean True or False indicating Flipkart generated form for the mentioned form.
forms. status String Indicates status of form generation. Status can be one of the below (NOT-CREATED, IN-PROGRESS, COMPLETED and FAILED)
subShipments List List of sub shipments associated with a shipment
subShipments. subShipmentId String Primary identifier for a specific sub shipment.
subShipments. packages List List of packages inside one sub shipment
subShipments. packageId String Primary identifier for a specific package
subShipments. quantity Integer Quantity of sub shipments
subShipments. packageTitle String Title of the package
subShipments. packageSku String SKU of the package

Validations

orderIds: should be valid order ids for this seller

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting forms for the shipment

POST/v3/shipments/labels

Description - The Label Generation API (also known as the Pack API) generates invoice and shipping labels for the shipment ids and marks shipments as packed. It takes the invoice details in the request as input. If the orderItemId requires a serial number or IMEI number (also known as serialized product), that input is also required when calling this API.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/labels

Request Body Parameter

Parameter/Attribute Type Requirement Description
shipments List of shipments Mandatory List of shipment ids for pack
shipmentId String Mandatory Unique number that identifies the shipment.
locationId String Mandatory Id which refers to seller’s dispatch location.
taxItems List of tax items Mandatory List of taxable items
taxItems. orderItemId String Mandatory The orderItemId of the primary shipment Item.
taxItems. taxRate Numeric Mandatory Tax Rate for the Item
taxItems. quantity Numeric Mandatory Quantity of items to be shipped.
serialNumbers List of serial numbers Mandatory only if item is serialized Serial number array for serialized products
serialNumbers. orderItemId String Mandatory orderItemId for which serial number is being input
serialNumbers. serialNumbers List<List<String>> Mandatory serialNumbers for the given order item id
subShipments List of sub shipments Mandatory List of subShipments associated with the shipment
subShipments. subShipment String Mandatory Primary identifier for a specific sub shipment.
subShipments. dimensions. length Float Mandatory Length of the sub-shipment
subShipments. dimensions. breadth Float Mandatory Breadth of the sub-shipment
subShipments. dimensions. height Float Mandatory Height of the sub-shipment
subShipments. dimensions. width Float Mandatory Width of the sub-shipment
invoices List of invoice details Mandatory Invoice details for the shipment
invoices. orderId String Mandatory Order id to which particular order item is associated.
invoices. invoiceNumber String Optional If the seller has not opted for auto invoicing, then this field is mandatory.

Validations

ShipmentId and Sub Shipment Id is mandatory.
Order Item id is mandatory.
Dimensions are mandatory and should be a positive value.

Response Body Parameters

Parameter/Attribute Type Description
shipments. shipmentId String Primary identifier for a specific shipment.
shipments. processingStatus String SUCCESS or FAILURE
shipments. errorCode String Error code for any error
shipments. errorMessage String Error message
Error Codes Reason for Error
FF_ITEM_ON_HOLD Error if shipment is on hold
FF_INVALID_PACK_REQUEST If all the order items inside shipment are not in approved state
FF_INCOMPLETE_SHIPMENT_DIMENSIONS Invalid dimensions given for particular sub shipment
SERVICIBILITY_NOT_ALLOWED Serviceability not allowed from seller location to buyer location
FF_PACK_TIN_NOT_FOUND Seller TIN number not found
FF_PACK_INVALID_DISPATCH_AFTER_DATE Dispatch After Date is greater than current time of pack
FF_PACK_OPERATION_NOT_AUTHORISED Seller not authorised for packing the shipment
FF_PACK_INVALID_IMEI Invalid IMEI number given for any serialised products

GET /v3/shipments/{shipmentIds}/labels

Description - The Download Labels API prints integrated shipping label and invoice (optional) for packed shipments. The invoice is printed only if the seller opts for the auto-invoicing solution. The shipping labels and customer invoices can be printed for multiple shipment ids. It produces a single, merged PDF, if multiple shipment IDs are passed in the request parameters.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/{shipmentIds}/labels

Request Header Parameters

Path Parameter Requirement Description
shipmentIds Mandatory Prints shipping label for shipmentIds

Validations

shipmentIds: should be a valid shipment ids for this seller and the label

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting forms for the shipment

GET /v3/shipments/{shipmentIds}/invoices

Description - The Shipment invoice API prints invoice for packed shipments. It gives pdf document if content type is application/pdf and gives json response if content type is application/json.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/{shipmentIds}/invoices

Request Header Parameters

Path Parameter Requirement Description
shipmentIds Mandatory Gives invoice details for shipmentIds

Response Body Parameters

Parameter/Attribute Type Content type Description
Invoice PDF PDFstream application/pdf Success - set of invoice pdf files else error.
invoices Json object of invoice details application/json Gives invoice details in json format
invoices. shipmentId String application/json Primary identifier for a specific shipment.
invoices. invoiceDate ISO Date application/json Date of invoice creation
invoices. InvoiceNumber String application/json Invoice number generated for that particular shipment
invoice. orderItems List of order items application/json List order item in one invoice
invoice. orderItems. orderItemId String application/json Order item id belonging to shipment
invoice. orderItems. invoiceAmount Float application/json Invoice amount for that order item id
invoice. orderItems. serialNumbers List of serial numbers application/json Serial numbers mentioned in invoice(Only for serialized products)
invoice. orderItems. TaxDetails GST Tax details application/json GST tax details object
invoice. orderItems. TaxDetails. cgstRate Float application/json CGST tax rate
invoice. orderItems. TaxDetails. sgstRate Float application/json SGST tax rate
invoice. orderItems. TaxDetails. igstRate Float application/json IGST tax rate

Validations

shipmentIds: should be a valid shipment ids for this seller

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting invoice for the shipment
INVALID_SHIPMENTS Invalid shipment Ids passed
OPERATION_NOT_ALLOWED Shipment ids does not belong to seller

POST/v3/shipments/dispatch

Description - 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 and Response Parameters

☰ SHOW | HIDE

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

Request Body Parameter

Parameter/Attribute Type Requirement Description
shipmentIds List<String> Mandatory List of shipment ids
locationId String Mandatory Seller’s location id from where item is dispatched

Validations

ShipmentIds and location Id are mandatory

Response Body Parameters

Parameter/Attribute Type Description
shipments. shipmentId String Primary identifier for a specific shipment.
shipments. processingStatus String SUCCESS or FAILURE
shipments. errorCode String Error code for any error
shipments. errorMessage String Error message

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED This error occurs if an internal system fails during v3/shipments/dispatch call

GET/v3/shipments/{shipmentIds}

Description - The Shipments API gives the shipping details for multiple shipment ids based on the specified shipmentIds. The recommended limit is 25 shipmentIds.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/{shipmentIds}

Request Header Parameters

Path Parameter Requirement Description
shipmentIds Mandatory Gives shipping details for shipmentIds

Response Body Parameters

Parameter/Attribute Type Description
orderId String Identifies the order
deliveryAddress. firstName String First name of the recipient
deliveryAddress. lastName String Last name of the recipient
deliveryAddress. pincode String Pincode of the recipient address
deliveryAddress. city String City in the recipient address
deliveryAddress. stateName String State in which the deliveryAddress.city is located.
deliveryAddress. addressLine1 String Address Line 1 of the recipient address
deliveryAddress. addressLine2 String Address Line 2 of the recipient address
deliveryAddress. stateCode .String State Code corresponding to the State Name
deliveryAddress. state String State name of recipient
deliveryAddress. landmark String Landmark in the recipient address
deliveryAddress. contactNumber String Contact number of the recipient
shipmentId String Unique identifier to the Shipment
locationId String Id which refers to seller’s dispatch location
subShipments. subShipmentId String Identifies the sub shipments within a single shipment.
subShipments. courierDetails. pickupDetails. vendorName String Vendor name picking up the shipment from seller location
subShipments. courierDetails. pickupDetails. trackingId String Pick up courier tracking id
subShipments. courierDetails. deliveryDetails. vendorName String Vendor name delivering shipment to customer from mother hub
subShipments. courierDetails. deliveryDetails. trackingId String Delivery tracking id
subShipments. shipmentDimensions. length Float Length of the sub-shipment
subShipments. shipmentDimensions. breadth Float Breadth of the sub-shipment
subShipments. shipmentDimensions. height Float Height of the sub-shipment
subShipments. shipmentDimensions. weight Float Weight of the sub-shipment
sellerAddress. sellerName String Seller name as in the Seller’s Address
sellerAddress. pincode String Pincode in the Seller’s address
sellerAddress. city String City in the Seller’s address
sellerAddress. stateName String Name of the state in the Seller’s address
sellerAddress. addressLine1 String Address Line 1 in the Seller’s address
sellerAddress. addressLine2 String Address Line 2 in the Seller’s address
sellerAddress. stateCode String State Code in the Seller’s address
sellerAddress. state String State in which seller address located.
sellerAddress. landmark String Landmark in the Seller’s address
billingAddress. firstName String First Name of the recipient of the Bill.
billingAddress. lastName String Last Name of the recipient of the Bill.
billingAddress. pincode String Pincode in the Billing Address.
billingAddress. city String City in the Billing Address.
billingAddress. stateName String StateName in the Billing Address
billingAddress. addressLine1 String Address Line 1 in the Billing Address.
billingAddress. addressLine2 String Address Line 2 in the Billing Address.
billingAddress. stateCode String State Code in the Billing Address
billingAddress. state String State name of billing address
billingAddress. landmark String Landmark in the Billing Address
billingAddress. contactNumber String Contact Number in the Billing Address
buyerDetails. firstName String First Name of the Buyer
buyerDetails. lastName String Last Name of the Buyer
orderItems. large Boolean True or False indicating shipment is large
orderItems. dangerous Boolean True or False indicating shipment is dangerous
orderItems. id Boolean Order item id inside the shipment
orderItems. fragile Boolean True or False indicating shipment is fragile
returnAddress. firstName String First Name of the person to whom the items have to be returned to, if not delivered, as mentioned in the Return Address.
returnAddress. lastName String Last Name of the person to whom the items have to be returned to, if not delivered, as mentioned in the Return Address.
returnAddress. pincode String Pincode in the Return Address
returnAddress. city String City in the Return Address
returnAddress. addressLine1 String Address Line 1 in the Return Address
returnAddress. addressLine2 String Address Line 2 in the Return Address
returnAddress. stateCode String State Code in the Return Address
returnAddress. state String State name where shipment has to be returned
returnAddress. landmark String Landmark in the Return Address

Validations

shipmentIds: should be valid shipment ids for this seller

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting shipment details for the shipment

POST/v3/shipments/cancel

Description - The Shipment Cancel API enables the seller to cancel order items inside shipment that may already have been approved by the Flipkart Marketplace.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/cancel

Request Body Parameter

Parameter/Attribute Type Requirement Description
shipments List of Shipments Mandatory List of shipments which should be cancelled
shipments. shipmentId String Mandatory Primary identifier for a specific shipment.
shipments. locationId String Mandatory Id which refers to seller’s dispatch location
shipments. cancellationGroupIds String Mandatory Refers to the group of order items which will be cancelled.
shipments. reason String Mandatory Sub reason chosen for cancellation. cancellation should be one of the below(cannot_procure_item, not_enough_inventory, b2b_order)

Validations

Shipment Id, Cancellation Groups and Reason are mandatory.
Reason should be one of the specified reasons. I.E ``cannot_procure_item`` ,``not_enough_inventory`` and ``b2b_order``

Response Body Parameters

Parameter/Attribute Type Description
shipments. shipmentId String Primary identifier for a specific shipment.
shipments. processingStatus String SUCCESS or FAILURE
shipments. errorCode String Error code for any error
shipments. errorMessage String Error message

Possible Error Response Codes

Error Codes Reason for Error
EMPTY_OR_INVALID_REASON_FOR_CANCELLATION Cancellation reason is empty or invalid

GET/v3/shipments/{shipmentIds}/forms

Description - This api gives forms associated with the given shipment ids .

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/{shipmentIds}/forms

Request Header Parameters

Parameter | Requirement | Description
shipmentIds | Mandatory | List of shipment ids

Response Body Parameters

Parameter/Attribute Type Description
shipmentId String Primary identifier for a specific shipment.
forms.name String Name of the for associated with the shipment.
forms. link String Link to the Government portal for where particular form can be generated.
forms.automated boolean True or False indicating Flipkart generated form for the mentioned form.
forms.status String “Indicates status of form generation. Status can be one of the below (Not created, In-progress,Completed and Failed

Validations

shipmentIds: should be valid shipment ids for this seller

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting forms for the shipment

POST/v3/shipments/forms/updateAck

Description - This api updated ACK number for the forms associated with specified shipmentIds. If any forms associated with shipment ids fails. Seller should go yo government postal and fill the form manually and update the ACK number using this api.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/forms/updateAck

Request Body Parameters

Parameter/Attribute Type Requirement Description
shipments List of shipments Mandatory List of shipmentIds with form ACK update
shipmentId String Mandatory Primary identifier for a specific shipment.
forms List of forms Mandatory List of forms associated with the shipmentId
forms. name String Mandatory Name associated with the shipment.
forms. ackNumber String Mandatory ACK number got from government portal for particular for filled manually.

Validations

shipmentId, Forms Name and Acknowledgement number are mandatory

Response Body Parameters

Parameter/Attribute Type Description
shipments. shipmentId String Primary identifier for a specific shipment.
shipments. processingStatus String SUCCESS or FAILURE
shipments. errorCode String Error code for any error
shipments. errorMessage String Error message

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in updating ACK for the shipment

GET/v3/shipments/handover/counts?locationId={location_id}

Description - The get vendor details api gives number of shipments belong to particular vendor. It gives number of shipments in RTD state.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/handover/counts?locationId={location_id}

Request Header Parameters

Path Parameter Requirement Description
locationId Mandatory Id which refers to seller’s dispatch location

Response Body Parameters

Parameter/Attribute Type Description
vendorGroupCode String Vendor code to which dispatchable shipments belong
isMps Boolean Are shipments belong to Multi pack shipment
count Integer Number of dispatchable shipments for that vendor
pickUpDate. after ISO String Date time after pick up will be made by the particular vendor
pickUpDate. before ISO String Date time before pick up will be made by the particular vendor

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED This error occurs if an internal system fails during get vendor details call

POST/v3/shipments/manifest

Description - This API gives manifest PDF with shipments which belong to specified vendor.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/manifest

Request Body Parameters

Parameter/Attribute Type Requirement Description
params List of params Mandatory List of params with vendor details
vendorGroupCode String Mandatory Vendor code to which dispatchable shipments belong
locationId String Mandatory Id which refers to seller’s dispatch location
isMps Boolean Mandatory Do shipments belong to Multi pack shipment
pickUpDate. after DateTime Mandatory if mps is true. DateTime after when the vendor can pick up the Shipment.
pickUpDate. before DateTime Mandatory if mps is true. DateTime before when the vendor can pick up the Shipment.

Validations

The ``vendorGroupCode`` is a mandatory field.
If ``mps`` is true, then pick up dates are also mandatory

Possible Error Response Codes

Error Codes Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED Error in getting manifest details for the vendor

GET /returns

Description - The Get Returns API provides details of an order item returned by the buyer or undelivered by the courier, and the reason for return.

Request and Response Parameters

☰ SHOW | HIDE

URL: http://api.flipkart.net/sellers/v2/returns?source={source_mode}&modifiedAfter={date}&createdAfter={date}&locationId={locationId}

Request Header Parameters

Parameter Type Requirement Description
source String Mandatory Source of the returns. Possible values: customer_return, courier_return
modifiedAfter ISO String Optional Get the returns details for orders modified after the date specified
createdAfter ISO String Optional Get the returns details for orders created after the date specified
locationId String Mandatory Get the returns details for orders which belongs to sellers specified location

GET /returns?returnIds={id list}

Description - The Get Returns by returnIds API provides details of returns.

Request and Response Parameters

☰ SHOW | HIDE

URL: http://api.flipkart.net/sellers/v2/returns?returnIds={id list}

Request Header Parameters

Parameter Type Requirement Description
returnIds String Mandatory Comma separated list of returnsIds.

POST /shipments/dispatch

Description - Self Ship API to mark items as dispatched from the seller warehouse. In addition to marking items as dispatched from the warehouse, seller must enter invoice details.

POST /shipments/delivery

Description - Self Ship API to mark items as delivered to the buyer.

POST /shipments/deliveryAttempt

Description - Self Ship API to mark an attempted delivery. The next delivery date must be mentioned.

POST /services/attempt

Description - API to mark service attempt done by the service partner. The next scheduled service date is also marked.

POST /services/complete

Description - Self Ship API to mark a service as completed with the details of service.

POST /returns/approve

Description - Self Ship API to approve returns requested by the buyer with or without tech visit.

POST /returns/reject

Description - Self Ship API to mark returns requested by the buyer as rejected. Tech visit service is mandatory to reject the returns.

POST /returns/complete

Description - Self Ship API to acknowledge completion of returns to the seller warehouse.

POST /returns/pickup

Description - Selfship API to mark item as picked up from the buyer.

POST /returns/pickupAttempt

Description - Self Ship API to mark attempted pickup of the item from the buyer. The next pickup by date must be mentioned.