Catalog API Documentation

Browse endpoints, parameters, and live request examples.

GET /sockets/{socket_id}

Get catalog socket details

Retrieves detailed information for a specific catalog socket by its socket_id. Only sockets owned by the authenticated customer can be accessed.

Catalog

Parameters

socket_id required path (integer)

The socket ID to retrieve

include_download query (boolean)

When true, includes S3 download link for catalog SQLite file

Responses

200 Socket details response
Multi-currency socket

Socket configured for international sales with points disabled 

{
  "socket": {
    "currency": "EUR",
    "features": {
      "points_enabled": false
    },
    "language": "en",
    "point_to_currency_ratio": "1.00",
    "region": "EU",
    "socket_id": 1002,
    "socket_name": "EU Store"
  },
  "success": true,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}
Standard catalog socket

Typical socket configuration for a single storefront 

{
  "socket": {
    "currency": "USD",
    "features": {
      "points_enabled": true
    },
    "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:

Single catalog socket details

Type: object
Required fields:
success timestamp socket

Properties:

socket ref: Socket required
success required
timestamp required
401 Unauthorized access
Missing or invalid authentication 
{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication required. Please provide a valid Bearer token.",
  "success": false,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}
Response Schema
Schema Reference:

Standard error response format

Type: object
Required fields:
success message timestamp error_code

Properties:

error_code required
message required
success required
timestamp required
404 Socket not found
Socket doesn't exist or not accessible 
{
  "error_code": "NOT_FOUND",
  "message": "The requested resource was not found.",
  "success": false,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}
Response Schema
Schema Reference:

Standard error response format

Type: object
Required fields:
success message timestamp error_code

Properties:

error_code required
message required
success required
timestamp required
502 Manager API unavailable
Unable to retrieve catalog download link 
{
  "error_code": "BAD_GATEWAY",
  "message": "Unable to retrieve catalog download link",
  "success": false,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}
Response Schema
Schema Reference:

Standard error response format

Type: object
Required fields:
success message timestamp error_code

Properties:

error_code required
message required
success required
timestamp required
503 Manager API not configured
Catalog download service is not configured 
{
  "error_code": "SERVICE_UNAVAILABLE",
  "message": "Catalog download service is not configured",
  "success": false,
  "timestamp": "2025-08-05T00:44:25.846238Z"
}
Response Schema
Schema Reference:

Standard error response format

Type: object
Required fields:
success message timestamp error_code

Properties:

error_code required
message required
success required
timestamp required