Path parameters

• shopId integer(int64) Required
• listingPath string Required

Query parameters

• key string

Responses

• 200

  Page Info

  Hide response attributes Show response attributes object

  • data object
    Hide data attributes Show data attributes object

    • listing object
      Hide listing attributes Show listing attributes object

      • id integer(int64)
      • path string | null
      • searchWordsMeta string | null
      • position integer(int32)
      • minPriceDetails object
        Hide minPriceDetails attributes Show minPriceDetails attributes object

        • amount number(double)
        • currency string | null
        • Additional properties are NOT allowed
      • seo object
        Hide seo attributes Show seo attributes object

        • metaTitle string | null
        • metaDescription string | null
        • metaCfImageId string | null
        • Additional properties are NOT allowed
      • 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
        Hide product attributes Show product attributes object

        • id integer(int64)
        • title string | null
        • description string | null
        • shortDescription string | null
        • thumbnailCfImageId string | null
        • statistics object
          Hide statistics attributes Show statistics attributes object

          • rating number(float)
          • totalFeedbacks integer(int64)
          • totalProductsSold integer(int64)
          • customersCount integer(int64)
          • Additional properties are NOT allowed
        • variants array[object] | null
          Hide variants attributes Show variants attributes array[object] | null

          • id integer(int64)
          • title string | null
          • shortDescription string | null
          • description string | null
          • priceDetails object
            Hide priceDetails attributes Show priceDetails attributes object

            • amount number(double)
            • currency string | null
            • Additional properties are NOT allowed
          • productType integer(int32)

            " Serials = 0 Dynamic = 2 Service = 3 If you choose serials, you need to provide only asSerials property If you choose dynamic, you need to provide only asDynamic property If you choose service, you need to provide only asService property"

            Values are 0, 2, or 3.

          • asDynamic object
            Hide asDynamic attributes Show asDynamic attributes object

            • stock integer(int32) | null
            • minAmount integer(int32) | null
            • maxAmount integer(int32) | null
            • Additional properties are NOT allowed
          • asSerials object
            Hide asSerials attributes Show asSerials attributes object

            • stock integer(int32) | null
            • minAmount integer(int32) | null
            • maxAmount integer(int32) | null
            • Additional properties are NOT allowed
          • asService object
            Hide asService attributes Show asService attributes object

            • stock integer(int32) | null
            • minAmount integer(int32) | null
            • maxAmount integer(int32) | null
            • Additional properties are NOT allowed
          • gateways array[object] | null
            Hide gateways attributes Show gateways attributes array[object] | null

            • gateway integer(int32)

              " The list of supported payment gateways. CoinbaseCommerce = 0 Stripe = 1 PayPal = 2 CashApp = 3 PayPalFf = 4 VirtualPayments = 5 Square = 6

              "

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

            • rules object
              Hide rules attributes Show rules attributes object

              • blockVpn boolean
              • Additional properties are NOT allowed
            • price object
              Hide price attributes Show price attributes object

              • amount number(double)
              • currency string | null
              • Additional properties are NOT allowed
            • Additional properties are NOT allowed
          • customFields array[object] | null
            Hide customFields attributes Show customFields attributes array[object] | null

            • id integer(int64)
            • type integer(int32) Required

              Values are 1, 2, 3, 4, or 5.

            • name string Required

              Minimum length is 1, maximum length is 64.

            • required boolean Required
            • valueString string | null
            • placeholder string | null
            • regex string | null
            • valueInt integer(int32) | null
            • valueBool boolean | null
            • Additional properties are NOT allowed
          • warranty object
            Hide warranty attributes Show warranty attributes object

            • id integer(int64)
            • text string | null
            • durationSeconds integer(int32) | null
            • Additional properties are NOT allowed
          • discordSocialConnectSettings object
            Hide discordSocialConnectSettings attributes Show discordSocialConnectSettings attributes object

            • enabled boolean
            • required boolean
            • Additional properties are NOT allowed
          • Additional properties are NOT allowed
        • groupId integer(int64) | null
        • onHold boolean
        • unlisted boolean
        • private boolean
        • Additional properties are NOT allowed
      • group object
        Hide group attributes Show group attributes object

        • id integer(int64)
        • title string | null
        • description string | null
        • cfImageId string | null
        • listings array[object] | null
          Hide listings attribute Show listings attribute array[object] | null

          • Additional properties are NOT allowed
        • type integer(int32)

          Values are 0 or 1.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • feedbacks array[object] | null
      Hide feedbacks attributes Show feedbacks attributes array[object] | null

      • rating integer(int32) | null
      • comment string | null
      • sellerReply string | null
      • createdAt string(date-time) | null
      • updatedAt string(date-time) | null
      • Additional properties are NOT allowed
    • mainDetails object
      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
        Hide seoDetails attributes Show seoDetails attributes object

        • id integer(int64)
        • favIconUrl string | null
        • metaTitle string | null
        • metaDescription string | null
        • metaImageCfId string | null
        • Additional properties are NOT allowed
      • defaultDiscordSettings object
        Hide defaultDiscordSettings attributes Show defaultDiscordSettings attributes object

        • enabled boolean
        • required boolean
        • Additional properties are NOT allowed
      • design object
        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
        • 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
        • disableBusinessLogo boolean
        • disableReviews boolean
        • disableProductsSold boolean
        • hideOutOfStockProducts boolean
        • hideProductStock boolean
        • googleAnalyticsKey string | null
        • crispChatKey string | null
        • Additional properties are NOT allowed
        • primaryColor string | null
        • primaryColorAccent null | string
      • socialLinks array[object] | null
        Hide socialLinks attributes Show socialLinks attributes array[object] | null

        • platform integer(int32)

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

        • link string | null
        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
  • message string | null
  • errors array[string] | null
  • log string | null
  • Additional properties are NOT allowed
• 404

  Shop Not Found