Search shipments using filters

POST /sellers/v3/shipments/filter

This operation returns shipments based on applied filters

Request Body

filter object
type string required
Possible values: [preDispatch, postDispatch, cancelled]
states string[]
Possible values: [APPROVED, PACKING_IN_PROGRESS, FORM_FAILED, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, RETURN_REQUESTED, RETURNED, SHIPPED, DELIVERED, COMPLETED]
locationId string
sku string[]
orderDate object
from date-time
to date-time
dispatchAfterDate object
from date-time
to date-time
dispatchByDate object
from date-time
to date-time
modifiedDate object
from date-time
to date-time
shipmentTypes string[]
Possible values: [EXPRESS, NORMAL, SELF]
serviceProfiles string[]
Possible values: [FBF, NON_FBF, FBF_LITE]
dispatchServiceTiers string[]
Possible values: [EXPRESS, REGULAR]
cancellationDate object
from date-time
to date-time
cancellationType string
Possible values: [sellerCancellation, buyerCancellation, marketplaceCancellation]
pagination object
pageSize int32
sort object
field string
Possible values: [dispatchByDate, orderDate, modifiedDate, dispatchAfterDate]
order string
Possible values: [asc, desc]
sellerId string

Responses

successful operation

application/json

Schema
Example (from schema)

Schema

hasMore boolean
nextPageUrl string
shipments object[]
Array [
shipmentId string
dispatchByDate date-time
dispatchAfterDate date-time
updatedAt date-time
locationId string
hold boolean
mps boolean
packagingPolicy string
subShipments object[]
Array [
subShipmentId string
packages object[]
Array [
id string
name string required
dimensions object
length number required
breadth number required
height number required
weight number
notional_value object
amount number required
unit string required
Possible values: [PERCENTAGE, INR]
description string
handling object
fragile boolean required
]
]
orderItems object[]
Array [
orderItemId string
orderId string
cancellationGroupId string
orderDate date-time
cancellationDate date-time
paymentType string
Possible values: [COD, PREPAID]
status string
Possible values: [APPROVED, PACKING_IN_PROGRESS, FORM_FAILED, PACKED, READY_TO_DISPATCH, PICKUP_COMPLETE, CANCELLED, RETURN_REQUESTED, RETURNED, SHIPPED, DELIVERED, COMPLETED]
cancellationReason string
cancellationSubReason string
courierReturn boolean
quantity int32
fsn string
sku string
listingId string
hsn string
title string
packageIds string[]
priceComponents object
sellingPrice number
totalPrice number
shippingCharge number
customerPrice number
flipkartDiscount number
serviceProfile string
Possible values: [Flipkart_Fulfilment, Seller_Fulfilment, Smart_Fulfilment, FBF, NON_FBF, FBF_LITE]
is_replacement boolean
]
forms object[]
Array [
name string
link string
automated boolean
]
shipmentType string
]

{
  "hasMore": true,
  "nextPageUrl": "string",
  "shipments": [
    {
      "shipmentId": "string",
      "dispatchByDate": "2025-01-29T05:32:53.627Z",
      "dispatchAfterDate": "2025-01-29T05:32:53.627Z",
      "updatedAt": "2025-01-29T05:32:53.627Z",
      "locationId": "string",
      "hold": true,
      "mps": true,
      "packagingPolicy": "string",
      "subShipments": [
        {
          "subShipmentId": "string",
          "packages": [
            {
              "notional_value": {
                "amount": 0.7386281948385884,
                "unit": "PERCENTAGE"
              },
              "name": "name",
              "weight": 4.145608029883936,
              "description": "description",
              "handling": {
                "fragile": true
              },
              "id": "id",
              "dimensions": {
                "breadth": 3.616076749251911,
                "length": 9.301444243932576,
                "height": 2.027123023002322
              }
            }
          ]
        }
      ],
      "orderItems": [
        {
          "orderItemId": "string",
          "orderId": "string",
          "cancellationGroupId": "string",
          "orderDate": "2025-01-29T05:32:53.627Z",
          "cancellationDate": "2025-01-29T05:32:53.627Z",
          "paymentType": "COD",
          "status": "APPROVED",
          "cancellationReason": "string",
          "cancellationSubReason": "string",
          "courierReturn": true,
          "quantity": 0,
          "fsn": "string",
          "sku": "string",
          "listingId": "string",
          "hsn": "string",
          "title": "string",
          "packageIds": [
            "string"
          ],
          "priceComponents": {
            "sellingPrice": 0,
            "totalPrice": 0,
            "shippingCharge": 0,
            "customerPrice": 0,
            "flipkartDiscount": 0
          },
          "serviceProfile": "Flipkart_Fulfilment",
          "is_replacement": true
        }
      ],
      "forms": [
        {
          "name": "string",
          "link": "string",
          "automated": true
        }
      ],
      "shipmentType": "string"
    }
  ]
}