Order Management API Reference¶
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.
GET /v3/shipments?shipmentIds={} or, GET /v3/shipments?orderItemIds={} or, GET /v3/shipments?orderIds={}¶
Description - The Get by ShipmentIds API gets the shipment detail by shipmentId
or orderId
or orderItemId
. Note that this operation can accept either shipmentIds, orderIds or orderItemIds, but only one type of query param is accepted per invocation. It returns the shipmentDetails with the specified orderItemId
and all its sub shipments
and packages
.
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
.
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
.
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.
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.
POST /v3/shipments/{shipmentIds}/labelOnly/pdf¶
Description - Download labels for the shipments in PDF format
POST /v3/shipments/{shipmentIds}/labelOnly¶
Description - Download labels for the shipments in Byte-Stream format
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.
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.
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
.
Note that this operation returns shipping and tracking related details of the shipments e.g delivery / billing address, tracking id, buyer address, etc. Buyer contact number and email address would be provided only for self-ship
shipments.
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.
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.
POST /v3/shipments/manifest¶
Description - This API gives manifest PDF with shipments which belong to specified vendor.
POST /v3/shipments/selfShip/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. Flipkart now supports automated shipment status updates from select logistics vendors, with tracking IDs validated to support this feature. Note: The Allowed vendor list
Self Ship API provides a list of allowed logistics vendors for a seller, returning two parameters: name
(used as deliveryPartner
in the the Self Ship Dispatch API) and vendorcode
(used as deliveryPartnerCode
in the the Self Ship Dispatch API)
POST /v3/shipments/selfShip/delivery¶
Description - Self Ship API to mark items as delivered to the buyer. Note: For shipments with automated status updates, delivery status will be updated based on logistics vendor updates, eliminating the need for seller input.
GET /v3/shipments/otc/{locationId}?requestType={requestType}¶
Description - This API gives shipments’ OTCs based on given location and request type. (Note : This API will be available soon.)
POST /v2/services/attempt¶
Description - API to mark service attempt done by the service partner. The next scheduled service date is also marked.
POST /v2/services/complete¶
Description - Self Ship API to mark a service as completed with the details of service.
GET /v2/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. The first call to the API returns max 25 results. Calling the URL returned in the “nextUrl” field of the response gets the subsequent pages of the search result.
GET /v2/returns?returnIds={id list}¶
Description - The Get Returns by returnIds API provides details of returns.
POST /v2/returns/approve¶
Description - Self Ship API to approve returns requested by the buyer with or without tech visit.
POST /v2/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 /v2/returns/complete¶
Description - Self Ship API to acknowledge completion of returns to the seller warehouse.
POST /v2/returns/pickup¶
Description - Selfship API to mark item as picked up from the buyer.
POST /v2/returns/pickupAttempt¶
Description - Self Ship API to mark attempted pickup of the item from the buyer. The next pickup by date must be mentioned.