List Catalogs

Staging Env

https://api.stg.bidancer.com

GET

/catalog-service/v1/catalog/list

Last modified:2026-01-13 17:40:55

List all catalog with optional filters

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

Success response containing a cursor‐paginated list of

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.stg.bidancer.com/catalog-service/v1/catalog/list?take' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "status": "success",
    "message": "string",
    "data": [
        {
            "id": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "deletedAt": "2019-08-24T14:15:22.123Z",
            "businessId": "string",
            "title": "string",
            "description": "string",
            "descriptionHtml": "string",
            "nature": "string",
            "category": "string",
            "categoryId": "string",
            "altCategory": "string",
            "altCategoryId": "string",
            "vendor": "string",
            "productType": "string",
            "tags": [
                "string"
            ],
            "specifications": [
                {
                    "category": "string",
                    "fields": [
                        {
                            "name": "string",
                            "value": "string",
                            "valueType": "text",
                            "unit": "string",
                            "hint": "string"
                        }
                    ]
                }
            ],
            "publishedAt": "2019-08-24T14:15:22.123Z",
            "publishedScope": "global",
            "status": "active",
            "options": [
                {
                    "id": "string",
                    "name": "string",
                    "position": 0,
                    "values": [
                        "string"
                    ]
                }
            ],
            "images": [
                {
                    "id": "string",
                    "src": "http://example.com",
                    "position": 0,
                    "alt": "string",
                    "width": 0,
                    "height": 0
                }
            ],
            "image": {
                "id": "string",
                "src": "http://example.com",
                "position": 0,
                "alt": "string",
                "width": 0,
                "height": 0
            },
            "warranty": {
                "periodMonths": 0,
                "coverage": "string",
                "termsUrl": "http://example.com"
            },
            "returnPolicy": {
                "returnWindowDays": 0,
                "restockingFeePercent": 0,
                "conditions": [
                    "string"
                ]
            },
            "documentResource": {
                "type": "string",
                "url": "http://example.com",
                "label": "string"
            }
        }
    ],
    "pagination": {
        "type": "cursor",
        "pageSize": 0,
        "nextCursor": "string",
        "prevCursor": "string",
        "totalData": 0
    }
}

Modified at 2026-01-13 17:40:55

Health Check

Get Catalog