SCscalev
Business Stores

List business stores

Changed on

Requires the store:list scope.

get/v3/stores

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/stores
  • Auth
    • HTTP bearer
    • or API key in header authorization
    • or OAuth 2
      Authorization code: https://api.scalev.com/v3/oauth/authorize
      Token URL: https://api.scalev.com/v3/oauth/token scopes: store:list

Query parameters

page_sizeinteger

Number of items per page.

next_cursorstring

Opaque cursor for the next page.

previous_cursorstring

Opaque cursor for the previous page.

searchstring

Filter by store name.

product_idinteger

Filter stores attached to a product ID.

domainstring

Filter by custom domain URL.

has_domainboolean

Filter stores that have or do not have a custom domain.

Response

Paginated business store list

is_paginatedtrue required
has_nextboolean
has_previousboolean
next_cursorstring nullable
previous_cursorstring nullable
page_sizeinteger

Changes

  • 6b9152f04622Revision changes
    • info

      added the optional property // to the response with the status

  • 251b881b98ebRevision changes
    • warning

      removed the optional property // from the response with the status