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

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/catalogs/variants \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    array[object]
    required

example-1

{
"code": 200,
"message": "Success",
"data": [
{
"sku": "OTS",
"variantId": 65
}
]
}

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

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/catalogs/quick-product \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    array[object]
    required

example-1

{
"code": 200,
"message": "Success",
"data": [
{
"id": 65,
"product_id": 81,
"sku": "OTS",
"calculated_price": 89,
"image_url": "url",
"inventory_level": 999,
"option_values": [],
"variantSku": "OTS",
"productId": "81",
"variantId": "65",
"baseSku": "OTS",
"productName": "[Sample] Orbit Terrarium - Small",
"categories": [
23,
19
],
"price": 89,
"option": [],
"isVisible": "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

{
"code": 200,
"message": "Success",
"data": [
{
"isStock": "1",
"stock": 999,
"variantSku": "OTS",
"productId": "81",
"variantId": 65,
"baseSku": "OTS",
"productName": "[Sample] Orbit Terrarium - Small",
"categories": [
23,
19
],
"option": [],
"minQuantity": 0,
"maxQuantity": 0,
"isVisible": "1",
"modifiers": []
}
]
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?