List

You can use the list products API to get all the products.

Request parameters

Name	Type	Required/Optional	Description
afterProductId	string	Optional	Product ID used to fetch products after this in the database

Request Information

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

Sample request

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-products/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic AUTH_TOKEN' \
--data ''

JSON response example:

{
  "status": 200,
  "success": true,
  "data": {
    "products": [
      {
        "image": "https://cdn.shopify.com/s/files/1/0672/6267/7292/products/young-man-in-bright-fashion_925x_1f25586d-6ce7-4ae7-9b61-a14d7da56d16.jpg?v=1689587429",
        "publishedAt": {
          "_seconds": 1689587428,
          "_nanoseconds": 0
        },
        "variantIds": [
          "45719281008940"
        ],
        "name": "Ocean Blue Shirt",
        "currency": "INR",
        "handle": "ocean-blue-shirt",
        "id": "8459368759596",
        "photos": [
          {
            "photoUrl": "https://cdn.shopify.com/s/files/1/0672/6267/7292/products/young-man-in-bright-fashion_925x_1f25586d-6ce7-4ae7-9b61-a14d7da56d16.jpg?v=1689587429"
          }
        ],
        "minPrice": 50,
        "maxPrice": 50,
        "vendor": "partners-demo",
        "discount": 0,
        "tags": "men",
        "description": "<p>Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and tiled kalidoscope patterns.</p>",
        "catalogs": [
          {
            "name": "Pendants",
            "id": "453047615788"
          },
          {
            "name": "Bottles",
            "id": "473936298284"
          }
        ],
        "catalogIds": [
          "453047615788",
          "473936298284"
        ],
        "combinations": [
          {
            "quantity": 2,
            "discountedPrice": 50,
            "productId": "8459368759596",
            "price": 50,
            "custom": "Default Title",
            "name": "Default Title",
            "options": {
              "Title": "Default Title"
            },
            "id": "45719281008940"
          }
        ],
        "options": [
          {
            "name": "Title"
          }
        ]
      }
    ]
  }
}

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 catalog
description	string	Catalog description
image	string	Catalog image
handle	string	Catalog handle
variantIds	string[]	List of variant ids belongs to current product
currency	string	Currency of the country
photos	BikPhoto[]	List of photos
minPrice	number	Minimum price of the product
maxPrice	number	Maximum price of the product
discount	number	Discount if any
tags	string	Product tags
catalogs	BikCatalog[]	List of catalogs this product belongs to
catalogIds	string[]	List of catalog ids this product belongs to
combinations	BikCombination[]	List of product combinations

BikPhoto Type

Name	Type	Description
photoUrl	string	Product photo

BikCatalog Type

Name	Type	Description
id	string	Catalog id
name	string	Catalog name

BikCombination Type

Name	Type	Description
id	string	Combination id
name	string	Combination name
custom	string	Combination custom name
productId	string	Product id
price	number	Combination price
discountedPrice	number	Combination discount price
quantity	number	Combination quantity available

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.