Get all the needed information for main page of the shop

GET /v2/public/shops/{shopId}/main

Bearer

Path parameters

shopId integer(int64) Required

Query parameters

key string

Responses

200

text/plain

text/plain application/json text/json

Page Info
Hide response attributes Show response attributes object
- data object
  
  Additional properties are NOT allowed.
  
  Hide data attributes Show data attributes object
  
  shop object
  
  Additional properties are NOT allowed.
  
  Hide shop attributes Show shop attributes object
  
  title string | null
  
  description string | null
  
  buttonText string | null
  
  disableButton boolean
  
  disableTitle boolean
  
  disableDescription boolean
  
  statistics object
  
  Additional properties are NOT allowed.
  
  Hide statistics attributes Show statistics attributes object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  feedbacks array[object] | null
  
  Hide feedbacks attributes Show feedbacks attributes object
  
  rating integer(int32) | null
  
  comment string | null
  
  sellerReply string | null
  
  createdAt string(date-time) | null
  
  updatedAt string(date-time) | null
  
  announcements array[object] | null
  
  Hide announcements attributes Show announcements attributes object
  
  id integer(int64)
  
  path string | null
  
  title string | null
  
  shortDescription string | null
  
  buttonText string | null
  
  buttonLink string | null
  
  createdAt string(date-time)
  
  listings array[object] | null
  
  Hide listings attributes Show listings attributes object
  
  id integer(int64)
  
  path string | null
  
  searchWordsMeta string | null
  
  position integer(int32)
  
  minPriceDetails object
  
  Additional properties are NOT allowed.
  
  Hide minPriceDetails attributes Show minPriceDetails attributes object
  
  amount number(double)
  
  currency string | null
  
  seo object
  
  Additional properties are NOT allowed.
  
  Hide seo attributes Show seo attributes object
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaCfImageId string | null
  
  visibility integer(int32)
  
  " Public = 0 Private = 1 Unlisted = 2 "
  
  Values are 0, 1, or 2.
  
  type integer(int32)
  
  " Products = 0 Groups = 1 Categories = 3 "
  
  Values are 0, 1, or 3.
  
  product object
  
  Additional properties are NOT allowed.
  
  Hide product attributes Show product attributes object
  
  id integer(int64)
  
  title string | null
  
  shortDescription string | null
  
  thumbnailCfImageId string | null
  
  statistics object
  
  Additional properties are NOT allowed.
  
  Hide statistics attributes Show statistics attributes object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  groupId integer(int64) | null
  
  isInstantDelivery boolean
  
  isInStock boolean
  
  onHold boolean
  
  unlisted boolean
  
  private boolean
  
  group object
  
  Additional properties are NOT allowed.
  
  Hide group attributes Show group attributes object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  cfImageId string | null
  
  listings array[object] | null
  
  Additional properties are NOT allowed.
  
  type integer(int32)
  
  Values are 0 or 1.
  
  categories array[object] | null
  
  Hide categories attributes Show categories attributes object
  
  id integer(int64)
  
  name string | null
  
  listingIds array[integer(int64)] | null
- message string | null
- errors array[string] | null
- log string | null
Hide response attributes Show response attributes object
- data object
  
  Additional properties are NOT allowed.
  
  Hide data attributes Show data attributes object
  
  shop object
  
  Additional properties are NOT allowed.
  
  Hide shop attributes Show shop attributes object
  
  title string | null
  
  description string | null
  
  buttonText string | null
  
  disableButton boolean
  
  disableTitle boolean
  
  disableDescription boolean
  
  statistics object
  
  Additional properties are NOT allowed.
  
  Hide statistics attributes Show statistics attributes object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  feedbacks array[object] | null
  
  Hide feedbacks attributes Show feedbacks attributes object
  
  rating integer(int32) | null
  
  comment string | null
  
  sellerReply string | null
  
  createdAt string(date-time) | null
  
  updatedAt string(date-time) | null
  
  announcements array[object] | null
  
  Hide announcements attributes Show announcements attributes object
  
  id integer(int64)
  
  path string | null
  
  title string | null
  
  shortDescription string | null
  
  buttonText string | null
  
  buttonLink string | null
  
  createdAt string(date-time)
  
  listings array[object] | null
  
  Hide listings attributes Show listings attributes object
  
  id integer(int64)
  
  path string | null
  
  searchWordsMeta string | null
  
  position integer(int32)
  
  minPriceDetails object
  
  Additional properties are NOT allowed.
  
  Hide minPriceDetails attributes Show minPriceDetails attributes object
  
  amount number(double)
  
  currency string | null
  
  seo object
  
  Additional properties are NOT allowed.
  
  Hide seo attributes Show seo attributes object
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaCfImageId string | null
  
  visibility integer(int32)
  
  " Public = 0 Private = 1 Unlisted = 2 "
  
  Values are 0, 1, or 2.
  
  type integer(int32)
  
  " Products = 0 Groups = 1 Categories = 3 "
  
  Values are 0, 1, or 3.
  
  product object
  
  Additional properties are NOT allowed.
  
  Hide product attributes Show product attributes object
  
  id integer(int64)
  
  title string | null
  
  shortDescription string | null
  
  thumbnailCfImageId string | null
  
  statistics object
  
  Additional properties are NOT allowed.
  
  Hide statistics attributes Show statistics attributes object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  groupId integer(int64) | null
  
  isInstantDelivery boolean
  
  isInStock boolean
  
  onHold boolean
  
  unlisted boolean
  
  private boolean
  
  group object
  
  Additional properties are NOT allowed.
  
  Hide group attributes Show group attributes object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  cfImageId string | null
  
  listings array[object] | null
  
  Additional properties are NOT allowed.
  
  type integer(int32)
  
  Values are 0 or 1.
  
  categories array[object] | null
  
  Hide categories attributes Show categories attributes object
  
  id integer(int64)
  
  name string | null
  
  listingIds array[integer(int64)] | null
- message string | null
- errors array[string] | null
- log string | null
Hide response attributes Show response attributes object
- data object
  
  Additional properties are NOT allowed.
  
  Hide data attributes Show data attributes object
  
  shop object
  
  Additional properties are NOT allowed.
  
  Hide shop attributes Show shop attributes object
  
  title string | null
  
  description string | null
  
  buttonText string | null
  
  disableButton boolean
  
  disableTitle boolean
  
  disableDescription boolean
  
  statistics object
  
  Additional properties are NOT allowed.
  
  Hide statistics attributes Show statistics attributes object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  feedbacks array[object] | null
  
  Hide feedbacks attributes Show feedbacks attributes object
  
  rating integer(int32) | null
  
  comment string | null
  
  sellerReply string | null
  
  createdAt string(date-time) | null
  
  updatedAt string(date-time) | null
  
  announcements array[object] | null
  
  Hide announcements attributes Show announcements attributes object
  
  id integer(int64)
  
  path string | null
  
  title string | null
  
  shortDescription string | null
  
  buttonText string | null
  
  buttonLink string | null
  
  createdAt string(date-time)
  
  listings array[object] | null
  
  Hide listings attributes Show listings attributes object
  
  id integer(int64)
  
  path string | null
  
  searchWordsMeta string | null
  
  position integer(int32)
  
  minPriceDetails object
  
  Additional properties are NOT allowed.
  
  Hide minPriceDetails attributes Show minPriceDetails attributes object
  
  amount number(double)
  
  currency string | null
  
  seo object
  
  Additional properties are NOT allowed.
  
  Hide seo attributes Show seo attributes object
  
  metaTitle string | null
  
  metaDescription string | null
  
  metaCfImageId string | null
  
  visibility integer(int32)
  
  " Public = 0 Private = 1 Unlisted = 2 "
  
  Values are 0, 1, or 2.
  
  type integer(int32)
  
  " Products = 0 Groups = 1 Categories = 3 "
  
  Values are 0, 1, or 3.
  
  product object
  
  Additional properties are NOT allowed.
  
  Hide product attributes Show product attributes object
  
  id integer(int64)
  
  title string | null
  
  shortDescription string | null
  
  thumbnailCfImageId string | null
  
  statistics object
  
  Additional properties are NOT allowed.
  
  Hide statistics attributes Show statistics attributes object
  
  rating number(float)
  
  totalFeedbacks integer(int64)
  
  totalProductsSold integer(int64)
  
  customersCount integer(int64)
  
  groupId integer(int64) | null
  
  isInstantDelivery boolean
  
  isInStock boolean
  
  onHold boolean
  
  unlisted boolean
  
  private boolean
  
  group object
  
  Additional properties are NOT allowed.
  
  Hide group attributes Show group attributes object
  
  id integer(int64)
  
  title string | null
  
  description string | null
  
  cfImageId string | null
  
  listings array[object] | null
  
  Additional properties are NOT allowed.
  
  type integer(int32)
  
  Values are 0 or 1.
  
  categories array[object] | null
  
  Hide categories attributes Show categories attributes object
  
  id integer(int64)
  
  name string | null
  
  listingIds array[integer(int64)] | null
- message string | null
- errors array[string] | null
- log string | null
404

Shop Not Found

GET /v2/public/shops/{shopId}/main

curl \
 --request GET 'https://dev.sellpass.io/v2/public/shops/{shopId}/main' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": {
    "shop": {
      "title": "string",
      "description": "string",
      "buttonText": "string",
      "disableButton": true,
      "disableTitle": true,
      "disableDescription": true,
      "statistics": {
        "rating": 42.0,
        "totalFeedbacks": 42,
        "totalProductsSold": 42,
        "customersCount": 42
      }
    },
    "feedbacks": [
      {
        "rating": 42,
        "comment": "string",
        "sellerReply": "string",
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z"
      }
    ],
    "announcements": [
      {
        "id": 42,
        "path": "string",
        "title": "string",
        "shortDescription": "string",
        "buttonText": "string",
        "buttonLink": "string",
        "createdAt": "2025-05-04T09:42:00Z"
      }
    ],
    "listings": [
      {
        "id": 42,
        "path": "string",
        "searchWordsMeta": "string",
        "position": 42,
        "minPriceDetails": {
          "amount": 42.0,
          "currency": "string"
        },
        "seo": {
          "metaTitle": "string",
          "metaDescription": "string",
          "metaCfImageId": "string"
        },
        "visibility": 0,
        "type": 0,
        "product": {
          "id": 42,
          "title": "string",
          "shortDescription": "string",
          "thumbnailCfImageId": "string",
          "statistics": {
            "rating": 42.0,
            "totalFeedbacks": 42,
            "totalProductsSold": 42,
            "customersCount": 42
          },
          "groupId": 42,
          "isInstantDelivery": true,
          "isInStock": true,
          "onHold": true,
          "unlisted": true,
          "private": true
        },
        "group": {
          "id": 42,
          "title": "string",
          "description": "string",
          "cfImageId": "string",
          "listings": [
            {}
          ],
          "type": 0
        }
      }
    ],
    "categories": [
      {
        "id": 42,
        "name": "string",
        "listingIds": [
          42
        ]
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}

Response examples (200)

{
  "data": {
    "shop": {
      "title": "string",
      "description": "string",
      "buttonText": "string",
      "disableButton": true,
      "disableTitle": true,
      "disableDescription": true,
      "statistics": {
        "rating": 42.0,
        "totalFeedbacks": 42,
        "totalProductsSold": 42,
        "customersCount": 42
      }
    },
    "feedbacks": [
      {
        "rating": 42,
        "comment": "string",
        "sellerReply": "string",
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z"
      }
    ],
    "announcements": [
      {
        "id": 42,
        "path": "string",
        "title": "string",
        "shortDescription": "string",
        "buttonText": "string",
        "buttonLink": "string",
        "createdAt": "2025-05-04T09:42:00Z"
      }
    ],
    "listings": [
      {
        "id": 42,
        "path": "string",
        "searchWordsMeta": "string",
        "position": 42,
        "minPriceDetails": {
          "amount": 42.0,
          "currency": "string"
        },
        "seo": {
          "metaTitle": "string",
          "metaDescription": "string",
          "metaCfImageId": "string"
        },
        "visibility": 0,
        "type": 0,
        "product": {
          "id": 42,
          "title": "string",
          "shortDescription": "string",
          "thumbnailCfImageId": "string",
          "statistics": {
            "rating": 42.0,
            "totalFeedbacks": 42,
            "totalProductsSold": 42,
            "customersCount": 42
          },
          "groupId": 42,
          "isInstantDelivery": true,
          "isInStock": true,
          "onHold": true,
          "unlisted": true,
          "private": true
        },
        "group": {
          "id": 42,
          "title": "string",
          "description": "string",
          "cfImageId": "string",
          "listings": [
            {}
          ],
          "type": 0
        }
      }
    ],
    "categories": [
      {
        "id": 42,
        "name": "string",
        "listingIds": [
          42
        ]
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "log": "string"
}