Get

Use the Get Products API to retrieve product details by their IDs.

Request parameters

Name	Type	Required/Optional	Description
productIds	string[]	Required	Array of product IDs to retrieve

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	HTTP status code
success	boolean	Indicates whether the request succeeded
data	BikProducts	Product data

BikProduct Type

Name	Type	Description
id	string	Product ID
name	string	Product name
url	string	Storefront URL
description	string	Product description
image	string	Product image URL
currency	string	Currency code
photos	BikPhoto[]	Array of product photos
tags	string	Comma-separated product tags
catalogIds	string[]	IDs of catalogs this product belongs to
combinations	BikCombination[]	Array of product variant combinations
metafields	Metafield[]	Metafields associated with the product
addToCartDisabled	boolean	If true, the Add to Cart button should be hidden for this product

BikPhoto Type

Name	Type	Description
photoUrl	string	Photo URL

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	Parent product ID
price	number	Combination price
discountedPrice	number	Discounted price
quantity	number	Available quantity
image	string	Combination image URL
productUrl	string	Combination product URL
currency	string	Currency code
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."
    }
  ]
}