Skip to main content

Start OTC Details

POST /sellers/v3/returns/otc/start/details

The Start OTC API serves the same purpose as the Generate Start OTC button on the FK Seller Hub. On hitting the API, the FEs who have reached the location, along with their Start OTCs, are returned in response. The API generates One-time codes for FEs who have reached the seller location and are on the Start OTC page. OTCs are generated ONLY for FEs who have reached the seller location and are on the Start OTC page. Each OTC has an expiry time and must be used before expiration. If no FEs are on the Start OTC page, otcDetails will be empty.

Request Body required

Request body for start OTC details

  • sellerLocationId string required

    Seller location identifier

  • taskType string required

    Possible values: [RETURN]

    Task type - must be RETURN

Responses

successful operation

Schema
  • otcDetails object

    OTC details mapped by feId. Will be empty if no FEs are on the Start OTC page

  • property name* object (OtcDetail)
  • feName string

    Field Executive name

  • taskId string

    Task identifier

  • otc string

    One-time code

  • expiryTime int64

    OTC expiry timestamp (Epoch format in milliseconds)

  • createdAt int64

    OTC creation timestamp (Epoch format in milliseconds)

  • logisticPartner string

    Logistics partner name

  • lob string

    Possible values: [LARGE, NONLARGE]

    Line of Business

Loading...