Skip to main content

End OTC Details

POST /sellers/v3/returns/otc/end/details

When the Generate End OTC is clicked, the summary of the scanned shipments with statistics, as well as the End OTC, is shown. The same information can be fetched using the End OTC API as well. After the End OTC has been verified by the FE, the returnCompleted order event notification will get pushed by the Order Management Notification Service. All shipments must be synced before ending End OTC. Shipment scanning API (POST /v3/returns/tasks/shipments) must be called at least once before calling End OTC API. FE must be on the End OTC page (not actively scanning). FE cannot go back from End OTC to Scanning again.

Request Body required

Request body for end OTC details

  • feId string required

    Field Executive identifier

  • taskId string required

    Task identifier

  • taskType string required

    Possible values: [RETURN]

    Task type - must be RETURN

Responses

successful operation

Schema
  • otc string

    One-time code

  • totalScanned integer

    Total shipments scanned

  • obdEligible integer

    OBD eligible shipments

  • obdFailed integer

    OBD failed shipments

  • flyerEligible integer

    Flyer eligible shipments

  • flyerFailed integer

    Flyer failed shipments

Loading...