find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/snackmagic:snackmagic-store-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: '### *Stadium’s API can only be used by customers and partners on the Business and Enterprise Packages.'
  version: 2.0.0
  title: Stadium Store management API
  termsOfService: https://www.bystadium.com/terms-of-use/
  contact:
    name: API Support
    email: engineering@bystadium.com
    url: https://www.bystadium.com
  x-logo:
    url: https://assets.auth0.bystadium.com/images/logos/color/stadium.svg
    altText: Stadium logo
servers:
- url: https://api.bystadium.com/api/v2
  description: Default server
- url: https://api.preprod.bystadium.com/api/v2
  description: Sandbox server
tags:
- name: Store management
  description: Store related API endpoints
paths:
  /stores:
    get:
      tags:
      - Store management
      summary: Get stores
      description: Get all the stores for the current user.
      operationId: getStores
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  stores:
                    type: array
                    items:
                      $ref: '#/components/schemas/Store'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidToken'
      security:
      - Token: []
  /stores/{store_number}/products:
    get:
      tags:
      - Store management
      summary: Get store products
      description: Get all the products for the store
      operationId: getStoreProducts
      parameters:
      - name: store_number
        in: path
        description: Number of store
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Page number
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: per_page
        in: query
        description: Number of products per page
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: sort_by
        in: query
        description: Example price:asc
        schema:
          type: string
      - name: country_code
        in: query
        description: '2-digit ISO Country Code (eg: US, IN). Deafult is US'
        schema:
          type: string
      - name: color
        in: query
        description: Filter products by color
        schema:
          type: string
      - name: size
        in: query
        description: Filter products by size
        schema:
          type: string
      - name: only_inactive_products
        in: query
        description: Filter products that are inactive
        schema:
          type: boolean
      - name: include_inactive_products
        in: query
        description: Filter products to include inactive as well
        schema:
          type: boolean
      - name: with_out_of_stock
        in: query
        description: Filter products to include out of stock as well
        schema:
          type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/MetaData'
                  products:
                    type: array
                    items:
                      $ref: '#/components/schemas/Product'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidToken'
      security:
      - Token: []
components:
  schemas:
    InvalidToken:
      type: object
      properties:
        error:
          type: string
          description: Error raised while trying to authorize the request
          example: Invalid token
    Taxon:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        taxonomyId:
          type: string
        taxonomyName:
          type: string
    PlatformFee:
      type: object
      properties:
        fee:
          type: number
          format: float
        type:
          type: string
          example: percent
    StoreConfig:
      type: object
      properties:
        currency_code:
          type: string
          example: STC
        currency_name:
          type: string
          example: Points
        currency_prefix:
          type: string
        currency_suffix:
          type: string
          example: Pts
    Store:
      type: object
      properties:
        name:
          type: string
          description: Name of store
          example: Build My Own Shop [BYO]
        code:
          type: string
          description: Store code
          example: build-my-own-shop-byo
        active:
          type: boolean
          description: Store is active or not
        created_at:
          type: string
          format: date-time
          description: Store Creation date
        url:
          type: string
          format: url
          description: Store Url
        banner:
          type: string
          format: url
          description: Store Banner Url
        number:
          type: string
          description: Store number to be used in other apis
          example: S235588918
        config:
          description: Store Currency Details
          allOf:
          - $ref: '#/components/schemas/StoreConfig'
        order_platform_fee:
          description: Platform Fee that will be charged on each order for this store
          allOf:
          - $ref: '#/components/schemas/PlatformFee'
    Product:
      type: object
      properties:
        id:
          description: Product ID
          allOf:
          - $ref: '#/components/schemas/Id'
        name:
          type: string
          description: Name of product
        description:
          type: string
          description: Description of store
        baseImage:
          type: string
          description: URL of product image
        displayImage:
          type: array
          description: URLs of product's display images
          items:
            type: string
        slug:
          type: string
          description: Slug of the product
        outOfStock:
          type: boolean
          description: Product is out of stock or not
        variants:
          type: array
          description: Variants of product
          items:
            $ref: '#/components/schemas/Variant'
        taxons:
          type: array
          description: Taxons of product
          items:
            $ref: '#/components/schemas/Taxon'
    OptionType:
      type: object
      properties:
        key:
          type: string
          example: color
        name:
          type: string
          example: Color
        presentation:
          type: string
          example: Blue
        value:
          type: string
          example: '#281E5D'
    Variant:
      type: object
      properties:
        id:
          type: string
          description: Id of product variant to be used to create order
          example: 0/0/0
        sku:
          type: string
        externalSource:
          type: string
          example: SnackMagic
        type:
          type: string
          example: Spree::Product
          description: Type of product variant to be used to create order
        price:
          type: float
          description: Price of product variant to be used to create order
        outOfStock:
          type: boolean
        optionTypes:
          type: array
          description: Variant Type Definitions
          items:
            $ref: '#/components/schemas/OptionType'
    MetaData:
      type: object
      properties:
        page:
          description: Current page number
          type: integer
          format: int32
        per_page:
          description: Number of products on current page
          type: integer
          format: int32
        total:
          description: Total number of products
          type: integer
          format: int32
    Id:
      type: integer
      format: int64
      readOnly: true
  securitySchemes:
    Token:
      type: http
      in: header
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: SnackMagic
  source: https://api.bystadium.com/api/v2/docs/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)