Admin

List all outlets

Retrieve a list of all outlets.

get/admin/outlets

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/admin/outlets
  • Auth: HTTP bearer

Query parameters

limitnumber nullable
pagenumber nullable
order_by'asc' | 'desc'
sort_bystring
include_archived'true' | 'false'
skip_pagination'true' | 'false'
is_hidden'true' | 'false'
status'DRAFT' | 'PENDING_REVIEW' | 'PENDING_AGREEMENT' | 'REJECTED' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED' | 'SUSPENDED' | 'PENDING_VERIFICATION'
provider_idstring uuid
searchstring

Response

Outlets retrieved successfully

total_pagesnumber required
current_pagenumber required
next_pagenumber nullable required
previous_pagenumber nullable required
total_recordsnumber required

Example response

{
  "records": [
    {
      "status": "DRAFT"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.