Get all the needed information for products page of the shop

GET /v2/public/shops/{shopId}/listings
Bearer

Path parameters

  • shopId integer(int64) Required

Query parameters

  • key string

Responses

  • 200

    Page Info

    Hide response attributes Show response attributes object
    • data object

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • mainDetails object

        Additional properties are NOT allowed.

        Hide mainDetails attributes Show mainDetails attributes object
        • id integer(int64)
        • name string | null
        • discordOauthUrl string | null
        • shopPopUp string | null
        • shopTerms string | null
        • onHold boolean
        • enableFaq boolean
        • passwordProtected boolean
        • balanceEnabled boolean
        • subscriptionName string | null
        • seoDetails object

          Additional properties are NOT allowed.

          Hide seoDetails attributes Show seoDetails attributes object
          • id integer(int64)
          • favIconUrl string | null
          • metaTitle string | null
          • metaDescription string | null
          • metaImageCfId string | null
        • defaultDiscordSettings object

          Additional properties are NOT allowed.

          Hide defaultDiscordSettings attributes Show defaultDiscordSettings attributes object
          • enabled boolean
          • required boolean
        • design object

          Additional properties are NOT allowed.

          Hide design attributes Show design attributes object
          • cfImageId string | null
          • title string | null
          • description string | null
          • buttonText string | null
          • disableButton boolean
          • disableTitle boolean
          • disableDescription boolean
          • backgroundCfImageId string | null
          • backgroundColor string | null
          • primaryColor string | null
          • primaryColorAccent string | null
          • secondaryColor string | null
          • primaryTextColor string | null
          • secondaryTextColor string | null
          • disableShadows boolean
          • disableSnow boolean
          • disableSupport boolean
          • isMainPageVisible boolean
          • fontLink string | null
          • darkMode boolean
          • disableBusinessName boolean
          • disableSearchBar boolean
          • centerProductTitle boolean
          • disableReviews boolean
          • disableProductsSold boolean
          • hideOutOfStockProducts boolean
          • hideProductStock boolean
          • googleAnalyticsKey string | null
          • crispChatKey string | null
        • socialLinks array[object] | null
          Hide socialLinks attributes Show socialLinks attributes object
          • platform integer(int32)

            Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

          • link string | null
      • 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
      • mainDetails object

        Additional properties are NOT allowed.

        Hide mainDetails attributes Show mainDetails attributes object
        • id integer(int64)
        • name string | null
        • discordOauthUrl string | null
        • shopPopUp string | null
        • shopTerms string | null
        • onHold boolean
        • enableFaq boolean
        • passwordProtected boolean
        • balanceEnabled boolean
        • subscriptionName string | null
        • seoDetails object

          Additional properties are NOT allowed.

          Hide seoDetails attributes Show seoDetails attributes object
          • id integer(int64)
          • favIconUrl string | null
          • metaTitle string | null
          • metaDescription string | null
          • metaImageCfId string | null
        • defaultDiscordSettings object

          Additional properties are NOT allowed.

          Hide defaultDiscordSettings attributes Show defaultDiscordSettings attributes object
          • enabled boolean
          • required boolean
        • design object

          Additional properties are NOT allowed.

          Hide design attributes Show design attributes object
          • cfImageId string | null
          • title string | null
          • description string | null
          • buttonText string | null
          • disableButton boolean
          • disableTitle boolean
          • disableDescription boolean
          • backgroundCfImageId string | null
          • backgroundColor string | null
          • primaryColor string | null
          • primaryColorAccent string | null
          • secondaryColor string | null
          • primaryTextColor string | null
          • secondaryTextColor string | null
          • disableShadows boolean
          • disableSnow boolean
          • disableSupport boolean
          • isMainPageVisible boolean
          • fontLink string | null
          • darkMode boolean
          • disableBusinessName boolean
          • disableSearchBar boolean
          • centerProductTitle boolean
          • disableReviews boolean
          • disableProductsSold boolean
          • hideOutOfStockProducts boolean
          • hideProductStock boolean
          • googleAnalyticsKey string | null
          • crispChatKey string | null
        • socialLinks array[object] | null
          Hide socialLinks attributes Show socialLinks attributes object
          • platform integer(int32)

            Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

          • link string | null
      • 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
      • mainDetails object

        Additional properties are NOT allowed.

        Hide mainDetails attributes Show mainDetails attributes object
        • id integer(int64)
        • name string | null
        • discordOauthUrl string | null
        • shopPopUp string | null
        • shopTerms string | null
        • onHold boolean
        • enableFaq boolean
        • passwordProtected boolean
        • balanceEnabled boolean
        • subscriptionName string | null
        • seoDetails object

          Additional properties are NOT allowed.

          Hide seoDetails attributes Show seoDetails attributes object
          • id integer(int64)
          • favIconUrl string | null
          • metaTitle string | null
          • metaDescription string | null
          • metaImageCfId string | null
        • defaultDiscordSettings object

          Additional properties are NOT allowed.

          Hide defaultDiscordSettings attributes Show defaultDiscordSettings attributes object
          • enabled boolean
          • required boolean
        • design object

          Additional properties are NOT allowed.

          Hide design attributes Show design attributes object
          • cfImageId string | null
          • title string | null
          • description string | null
          • buttonText string | null
          • disableButton boolean
          • disableTitle boolean
          • disableDescription boolean
          • backgroundCfImageId string | null
          • backgroundColor string | null
          • primaryColor string | null
          • primaryColorAccent string | null
          • secondaryColor string | null
          • primaryTextColor string | null
          • secondaryTextColor string | null
          • disableShadows boolean
          • disableSnow boolean
          • disableSupport boolean
          • isMainPageVisible boolean
          • fontLink string | null
          • darkMode boolean
          • disableBusinessName boolean
          • disableSearchBar boolean
          • centerProductTitle boolean
          • disableReviews boolean
          • disableProductsSold boolean
          • hideOutOfStockProducts boolean
          • hideProductStock boolean
          • googleAnalyticsKey string | null
          • crispChatKey string | null
        • socialLinks array[object] | null
          Hide socialLinks attributes Show socialLinks attributes object
          • platform integer(int32)

            Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

          • link string | null
      • 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}/listings 
curl \
 --request GET 'https://dev.sellpass.io/v2/public/shops/{shopId}/listings' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": {
    "mainDetails": {
      "id": 42,
      "name": "string",
      "discordOauthUrl": "string",
      "shopPopUp": "string",
      "shopTerms": "string",
      "onHold": true,
      "enableFaq": true,
      "passwordProtected": true,
      "balanceEnabled": true,
      "subscriptionName": "string",
      "seoDetails": {
        "id": 42,
        "favIconUrl": "string",
        "metaTitle": "string",
        "metaDescription": "string",
        "metaImageCfId": "string"
      },
      "defaultDiscordSettings": {
        "enabled": true,
        "required": true
      },
      "design": {
        "cfImageId": "string",
        "title": "string",
        "description": "string",
        "buttonText": "string",
        "disableButton": true,
        "disableTitle": true,
        "disableDescription": true,
        "backgroundCfImageId": "string",
        "backgroundColor": "string",
        "primaryColor": "string",
        "primaryColorAccent": "string",
        "secondaryColor": "string",
        "primaryTextColor": "string",
        "secondaryTextColor": "string",
        "disableShadows": true,
        "disableSnow": true,
        "disableSupport": true,
        "isMainPageVisible": true,
        "fontLink": "string",
        "darkMode": true,
        "disableBusinessName": true,
        "disableSearchBar": true,
        "centerProductTitle": true,
        "disableBusinessLogo": true,
        "disableReviews": true,
        "disableProductsSold": true,
        "hideOutOfStockProducts": true,
        "hideProductStock": true,
        "googleAnalyticsKey": "string",
        "crispChatKey": "string"
      },
      "socialLinks": [
        {
          "platform": 0,
          "link": "string"
        }
      ]
    },
    "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": {
    "mainDetails": {
      "id": 42,
      "name": "string",
      "discordOauthUrl": "string",
      "shopPopUp": "string",
      "shopTerms": "string",
      "onHold": true,
      "enableFaq": true,
      "passwordProtected": true,
      "balanceEnabled": true,
      "subscriptionName": "string",
      "seoDetails": {
        "id": 42,
        "favIconUrl": "string",
        "metaTitle": "string",
        "metaDescription": "string",
        "metaImageCfId": "string"
      },
      "defaultDiscordSettings": {
        "enabled": true,
        "required": true
      },
      "design": {
        "cfImageId": "string",
        "title": "string",
        "description": "string",
        "buttonText": "string",
        "disableButton": true,
        "disableTitle": true,
        "disableDescription": true,
        "backgroundCfImageId": "string",
        "backgroundColor": "string",
        "primaryColor": "string",
        "primaryColorAccent": "string",
        "secondaryColor": "string",
        "primaryTextColor": "string",
        "secondaryTextColor": "string",
        "disableShadows": true,
        "disableSnow": true,
        "disableSupport": true,
        "isMainPageVisible": true,
        "fontLink": "string",
        "darkMode": true,
        "disableBusinessName": true,
        "disableSearchBar": true,
        "centerProductTitle": true,
        "disableBusinessLogo": true,
        "disableReviews": true,
        "disableProductsSold": true,
        "hideOutOfStockProducts": true,
        "hideProductStock": true,
        "googleAnalyticsKey": "string",
        "crispChatKey": "string"
      },
      "socialLinks": [
        {
          "platform": 0,
          "link": "string"
        }
      ]
    },
    "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"
}