Skip to main content

Initial Page Load

POST /sellers/v3/returns/tasks/initial-load

The Initial Page Load API is specifically designed to execute only when the system detects shipments scheduled for delivery today. This API serves a foundational purpose by fetching essential core identifiers, such as feId and taskId, along with other necessary details. Crucially, the API also retrieves configuration data that is subsequently utilised in the workflow to determine if the Generate Start OTC button should be visible or hidden on the dashboard, based on the enabled configuration settings. This API only returns FEs that are currently on the Start OTC page, End OTC page, or Scanning. It does NOT return FEs that haven't arrived yet or have completed their task.

Request Body required

Request body for initial page load

  • sellerLocationId string required

    Seller location identifier

  • taskType string required

    Possible values: [RETURN]

    Task type - must be RETURN

Responses

successful operation

Schema
  • sellerConfig object
  • enabledFor string

    Possible values: [OldStatic, NewStatic, DynamicStartEnd, DynamicEnd]

    OTC flow configuration

  • feDetails object

    Field Executive details mapped by feId

  • property name* object (FeDetail)
  • feName string

    Field Executive name

  • logisticPartner string

    Logistics partner name

  • lob string

    Possible values: [LARGE, NONLARGE]

    Line of Business

  • task object
  • id string

    Task identifier

  • status string

    Task status

  • createdAt int64

    Task creation timestamp

Loading...