Get

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

Request parameters

Name	Type	Required/Optional	Description
catalogIds	string[]	Required	List of catalog ids

Request Information

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

Sample request

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-catalogs/get' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic AUTH_TOKEN' \
--data '{
    "catalogIds": ["453047550251"]
}'

JSON response example:

{
  "status": 200,
  "success": true,
  "data": {
    "catalogs": [
      {
        "image": null,
        "isSmartCollection": true,
        "name": "Necklace",
        "handle": "necklace",
        "id": "453047550251",
        "isPrivate": true,
        "isHidden": true,
        "description": "Explore collection of all our necklaces"
      }
    ]
  }
}

Response parameters

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

BikCatalog Type

Name	Type	Description
id	string	Catalog ID
name	string	Name of the catalog
description	string	Catalog description
image	string	Catalog image
handle	string	Catalog handle
isSmartCollection	boolean	Is the catalog is a smart collection or not
isPrivate	boolean	Is the catalog is private
isHidden	boolean	Is the catalog is hidden

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": "'catalogIds' is required."
    }
  ]
}