Get

You can use the get products API to get the catalogs details.

Request parameters

Name	Type	Required/Optional	Description
productIds	string[]	Required	List of product ids

Request Information

Category	Value
Http request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-products/get

Sample request

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-products/get' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic AUTH_TOKEN' \
--data '{
    "productIds": ["prod_nova_x1", "prod_usb_c_cable"]
}'

JSON response example (electronics store — one product with variants, one without):

{
  "status": 200,
  "success": true,
  "data": {
    "products": [
      {
        "id": "prod_nova_x1",
        "name": "Nova X1 Smartphone",
        "url": "https://electronics-store.com/products/nova-x1",
        "description": "6.7-inch AMOLED display, 108MP camera, 5000mAh battery.",
        "image": "https://cdn.electronics-store.com/nova-x1/hero.jpg",
        "currency": "INR",
        "tags": "smartphone,5g,android",
        "catalogIds": ["cat_smartphones"],
        "photos": [
          { "photoUrl": "https://cdn.electronics-store.com/nova-x1/front.jpg" },
          { "photoUrl": "https://cdn.electronics-store.com/nova-x1/back.jpg" }
        ],
        "combinations": [
          {
            "id": "var_nova_x1_black_128",
            "productId": "prod_nova_x1",
            "name": "Midnight Black / 128GB",
            "price": 49999,
            "discountedPrice": 44999,
            "currency": "INR",
            "quantity": 25,
            "image": "https://cdn.electronics-store.com/nova-x1/black.jpg",
            "productUrl": "https://electronics-store.com/products/nova-x1?variant=black-128",
            "options": { "Color": "Midnight Black", "Storage": "128GB" }
          }
        ],
        "metafields": [
          {
            "id": "mf_nova_x1_warranty",
            "namespace": "specs",
            "key": "warranty_months",
            "value": "12"
          }
        ]
      },
      {
        "id": "prod_usb_c_cable",
        "name": "Braided USB-C Cable — 1m",
        "url": "https://electronics-store.com/products/usb-c-cable-1m",
        "description": "Durable braided USB-C to USB-C cable, 100W PD, 1 meter.",
        "image": "https://cdn.electronics-store.com/usb-c-cable/hero.jpg",
        "currency": "INR",
        "tags": "accessory,cable,usb-c",
        "photos": [
          { "photoUrl": "https://cdn.electronics-store.com/usb-c-cable/hero.jpg" }
        ],
        "combinations": [
          {
            "id": "var_usb_c_cable_default",
            "productId": "prod_usb_c_cable",
            "name": "Default",
            "price": 799,
            "discountedPrice": 599,
            "currency": "INR",
            "quantity": 200,
            "image": "https://cdn.electronics-store.com/usb-c-cable/hero.jpg",
            "productUrl": "https://electronics-store.com/products/usb-c-cable-1m"
          }
        ]
      }
    ]
  }
}

Response parameters

Name	Type	Description
status	number	Response status
success	boolean	Is successful response or not
data	BikProducts	List of products

BikProduct Type

Name	Type	Description
id	string	Product ID
name	string	Name of the product
url	string	URL of the product on the storefront
description	string	Product description
image	string	Product image
currency	string	Currency of the country
photos	BikPhoto[]	List of photos
tags	string	Comma-separated product tags
catalogIds	string[]	List of catalog ids this product belongs to
combinations	BikCombination[]	List of product combinations
metafields	Metafield[]	Metafields associated with the product

BikPhoto Type

Name	Type	Description
photoUrl	string	Product photo

Metafield Type

Name	Type	Description
id	string	Metafield id
namespace	string	Metafield namespace
key	string	Metafield key
value	string	Metafield value

BikCombination Type

Name	Type	Description
id	string	Combination id
name	string	Combination name
productId	string	Product id
price	number	Combination price
discountedPrice	number	Combination discount price
quantity	number	Combination quantity available
image	string	Combination image
productUrl	string	Combination product url
currency	string	Currency of the combination
options	object	Map of variant option values, e.g. { "Size": "XL", "Color": "Red" }

Errors

Error Code	Meaning
400	Invalid payload -- Your request is invalid.
401	Unauthorized -- User is not authenticated.
404	Not Found -- The specified API could not be found.
500	Internal Server Error -- We had a problem with our server. Try again later.

Error response example:

{
  "status": 400,
  "errors": [
    {
      "message": "'productIds' is required."
    }
  ]
}