Skip to main content

Shipment Scanning

POST /sellers/v3/returns/tasks/shipments

After the Start OTC has been validated, the shipment scanning page is shown for the FE in the FK Seller Hub. As shipments get scanned, the count of shipments in Handover in progress keeps increasing. The response contains the information if more shipments are there to be scanned (hasMore Parameter), along with the encoded URL of the next shipment to be scanned (nextUrl Parameter). The encoded URL of the next shipment forms the URL for the request for next Subsequent Requests API call. In the Shipments Scanning API, after all the shipments have been scanned, the hasMore Parameter will become false, and the nextUrl Parameter will become null. This information can then be used to understand that the scanning of the shipments has been completed and to move to the end OTP generation API after the count of the shipments has been verified and they have been handed over. The API supports pagination for retrieving historical data. It should be called every 30 seconds. Subsequent Requests: GET using nextUrl from previous response. The nextUrl is base64 encoded and contains all query parameters. Use the hasMore flag to determine if more data might be available. Endpoint: POST /v3/returns/tasks/shipments (First request). Endpoint: GET /sellers/v3/returns/tasks/shipments/{encoded_url} (Subsequent requests). Base URL: https://api.flipkart.net/sellers.

Request Body required

Request body for first shipment scanning request

  • taskId string required

    Task identifier

  • feId string required

    Field Executive identifier

  • pageSize integer required

    Number of shipments to return per page

Responses

successful operation

Schema
  • hasMore boolean

    Indicates if more shipments are available

  • nextUrl string

    Base64 encoded URL for next page

  • scannedShipments object[]

    List of scanned shipments

  • Array [
  • trackingId string

    Shipment tracking ID

  • shipmentId string

    Shipment identifier

  • status string

    Possible values: [ACCEPTED, REJECTED]

    Shipment status

  • reason string nullable

    Reason for rejection (null if accepted)

  • flyerDetails object
  • actualFlyerId string

    Actual flyer ID

  • capturedFlyerId string

    Captured flyer ID

  • status string

    Flyer verification status

  • obdDetails object
  • eligible boolean

    OBD eligibility status

  • remark string

    OBD remark

  • imageLinks string[]

    List of image URLs

  • scannedAt int64

    Timestamp when shipment was scanned (in milliseconds)

  • ]
Loading...