Catalog API Documentation

Browse endpoints, parameters, and live request examples.

GET


          /sockets

List available catalogs and sockets

Retrieves all available catalog sockets that the authenticated user has access to. Each socket represents a different catalog or storefront with its own inventory, pricing, and localization settings.

Catalog

Responses

200 List of available catalogs

No catalogs configured

New customer account with no catalogs set up yet

{
  "sockets": [],
  "success": true,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}

Customer with multiple catalogs

Enterprise customer with multiple storefronts in different regions

{
  "sockets": [
    {
      "currency": "USD",
      "features": {},
      "language": "en",
      "point_to_currency_ratio": "100.00",
      "region": "US",
      "socket_id": 1001,
      "socket_name": "US Store"
    },
    {
      "currency": "EUR",
      "features": {},
      "language": "en",
      "point_to_currency_ratio": "120.00",
      "region": "EU",
      "socket_id": 1002,
      "socket_name": "EU Store"
    },
    {
      "currency": "GBP",
      "features": {
        "company_store": true
      },
      "language": "en",
      "point_to_currency_ratio": "140.00",
      "region": "GB",
      "socket_id": 1003,
      "socket_name": "UK Store"
    }
  ],
  "success": true,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}

Customer with single catalog

Most common scenario - customer has access to one catalog/storefront

{
  "sockets": [
    {
      "currency": "USD",
      "features": {},
      "language": "en",
      "point_to_currency_ratio": "100.00",
      "region": "US",
      "socket_id": 999,
      "socket_name": "Main Catalog"
    }
  ],
  "success": true,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}

Response Schema

Schema Reference:

List of catalog sockets available to the authenticated customer

Type:


        object

Required fields:


            success


            timestamp


            sockets

Properties:

sockets required

success required

timestamp required

401 Unauthorized access

Invalid Bearer token

Token is malformed, expired, or doesn't exist

{
  "error_code": "UNAUTHORIZED",
  "message": "Invalid Token or Customer",
  "success": false,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}

Missing Authorization header

Request made without Bearer token

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication required. Please provide a valid Bearer token.",
  "success": false,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}