Get

Retrieves catalog details for one or more catalogs by their IDs.

Request parameters

Name	Type	Required/Optional	Description
catalogIds	string[]	Required	Array of catalog IDs to retrieve

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": [
      {
        "name": "Necklace",
        "id": "453047550251",
        "description": "Explore collection of all our necklaces",
        "image": "https://cdn.shopify.com/s/files/1/0672/6267/7292/collections/necklace.jpg?v=1713341921",
        "url": "https://test-store.myshopify.com/collections/necklace"
      }
    ]
  }
}

Response parameters

Name	Type	Description
status	number	HTTP status code
success	boolean	Indicates whether the request succeeded
data	object	Object containing the catalogs array of BikPlatformCatalog

BikPlatformCatalog Type

Name	Type	Required/Optional	Description
name	string	Required	The name of the catalog
id	string	Required	The ID of the catalog
description	string	Optional	The description of the catalog
image	string	Optional	The URL of the catalog image
url	string	Optional	The URL of the catalog on the storefront

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."
    }
  ]
}