Storefront APIs
Catalog

Catalog

The Catalog refers to a store’s collection of physical and digital products.

Get Product Variants Info

GET /catalogs/variants

Request

Get variants list. Equivalent Storefront GraphQL API Query: productVariantsInfo. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • productId in query - string
    Unique product ID

example

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    array[object]
    required

example-1

Search Variant SKU

GET /catalogs/quick-product

Request

Get the catalogʼs product information by requesting the Get All Products BigCommerceʼs API. Equivalent Storefront GraphQL API Query: variantSku. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • variantSkus in query - string
    Variant SKU names, split by "|".
    Example: sku-1|sku-2|sku-3

example

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    array[object]
    required

example-1

Quick Order Pad

POST /catalogs/quick-order-pad

Request

Get products quickly. Equivalent Storefront GraphQL API Query: variantSku. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • variantSkus in query - string
    Variant SKU names, split by "|".

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    array[object]
    required

example-1

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?