The Pack Builder Settings API from OK Capsule — 1 operation(s) for pack builder settings.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ok-capsule-pack-builder-settings-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: '## Overview
The OK Capsule API enables you to programmatically create supplement orders, manage consumers, and track shipments.'
version: 2.0.0
title: OKC core API V2 Pack Builder Settings API
contact:
name: Engineering Department, OKCapsule
email: lukas@okcapsule.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- description: Production environment
url: https://na1-prod.okcapsule.app
- description: Stage/Testing environment
url: https://na1-stage.okcapsule.app
tags:
- name: Pack Builder Settings
paths:
/v2/pack-builders/{id}/settings:
post:
tags:
- Pack Builder Settings
security:
- bearerAuth: []
summary: Creates settings object for a pack builder
operationId: createPackBuilderSettings
description: Creates settings object for a pack builder.
parameters:
- $ref: '#/components/parameters/IdParameter'
- in: query
name: q
description: For internal users only. Use Query DSL *query_string* syntax to send client id.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- category_settings
- visual_settings
- protocol_settings
properties:
category_settings:
type: object
required:
- enable_product_categories
- category_selection_behavior
- category_menu_selection_behavior
- category_menu_text_align
properties:
enable_product_categories:
type: boolean
example: true
category_selection_behavior:
type: string
enum:
- scroll
- filter
example: scroll
category_menu_selection_behavior:
type: string
enum:
- bold
- underline
- fill
example: bold
category_menu_text_align:
type: string
enum:
- left
- center
- right
example: left
visual_settings:
type: object
required:
- layout
- product_cards
- typography
- colors
- buttons
- copy
properties:
layout:
type: object
required:
- product_view
- screen_width
- drawer_settings
- override
properties:
product_view:
type: string
enum:
- grid
- list
example: grid
screen_width:
type: string
enum:
- fixed
- flex
example: fixed
drawer_settings:
type: string
enum:
- temporary
- permanent
example: permanent
modal_mode:
type: string
enum:
- basic
- precision
- enhanced
- standard
example: basic
override:
type: boolean
example: false
product_cards:
type: object
required:
- image_aspect_ratio
- image_corners
- show_icon_labels
- cart_item_spacing_style
- override
properties:
image_aspect_ratio:
type: string
enum:
- '1:1'
- '4:3'
example: '1:1'
image_corners:
type: string
enum:
- rounded
- square
example: rounded
cycle_length:
type: integer
enum:
- 7
- 10
example: 7
show_icon_labels:
type: boolean
example: false
cart_item_spacing_style:
type: string
enum:
- default
- compact
- comfortable
example: compact
override:
type: boolean
example: false
typography:
type: object
required:
- text_size
- header_font
- body_font
- link_style
- override
properties:
text_size:
type: string
enum:
- small
- medium
- large
example: small
header_font:
type: object
required:
- font_family
- font_weight
properties:
font_family:
type: string
example: Open Sand
font_weight:
type: string
example: bold
body_font:
type: object
required:
- font_family
- font_weight
properties:
font_family:
type: string
example: Open Sand
font_weight:
type: string
example: regular
link_style:
type: string
enum:
- underline
- bold
- normal
example: underline
override:
type: boolean
example: false
colors:
type: object
required:
- primary_fill
- secondary_fill
- buttons
- icons
- header_text
- body_text
- links
- dividers
- override
properties:
primary_fill:
type: string
example: '#000000'
secondary_fill:
type: string
example: '#000000'
buttons:
type: string
example: '#000000'
icons:
type: string
example: '#000000'
header_text:
type: string
example: '#000000'
body_text:
type: string
example: '#000000'
links:
type: string
example: '#000000'
dividers:
type: string
example: '#000000'
override:
type: boolean
example: false
buttons:
type: object
required:
- corner_style
- ripple_effect
- checkout_button_text
- override
properties:
corner_style:
type: string
enum:
- square
- round
- soft
example: round
ripple_effect:
type: boolean
example: false
checkout_button_text:
type: string
example: ''
override:
type: boolean
example: false
copy:
type: object
required:
- empty_cart_message
- error_message
properties:
empty_cart_message:
type: string
example: ''
error_message:
type: string
example: ''
protocol_settings:
type: object
required:
- mode
properties:
mode:
type: string
enum:
- basic
- precision
- enhanced
- standard
example: basic
cycle_length:
type:
- integer
- 'null'
enum:
- 7
- 10
example: 7
examples:
PackBuilderSettingsSample:
$ref: '#/components/examples/PackBuilderSettingsSample'
responses:
'201':
description: Returns a created PackBuilderSettings object.
content:
application/json:
schema:
type: object
properties:
pack_builder_settings:
$ref: '#/components/schemas/PackBuilderSetting'
'422':
$ref: '#/components/responses/422ValidationError'
default:
$ref: '#/components/responses/UnknownError'
get:
tags:
- Pack Builder Settings
security:
- bearerAuth: []
summary: Retrieves a pack builders settings
operationId: listPackBuildersSettings
description: Retrieves a pack builders settings.
parameters:
- $ref: '#/components/parameters/IdParameter'
- in: query
name: q
description: For internal users only. Use Query DSL *query_string* syntax to send client id.
schema:
type: string
responses:
'200':
description: Search results matching criteria
content:
application/json:
schema:
type: object
required:
- pack_builder_settings
properties:
pack_builder_settings:
$ref: '#/components/schemas/PackBuilderSetting'
default:
$ref: '#/components/responses/UnknownError'
put:
tags:
- Pack Builder Settings
security:
- bearerAuth: []
summary: Update a pack builder settings
operationId: updatePackBuilderSettings
description: Update PackBuilderSettings object
parameters:
- $ref: '#/components/parameters/IdParameter'
- in: query
name: q
description: For internal users only. Use Query DSL *query_string* syntax to send client id.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- category_settings
- visual_settings
- protocol_settings
properties:
category_settings:
type: object
required:
- enable_product_categories
- category_selection_behavior
- category_menu_selection_behavior
- category_menu_text_align
properties:
enable_product_categories:
type: boolean
example: true
category_selection_behavior:
type: string
enum:
- scroll
- filter
example: scroll
category_menu_selection_behavior:
type: string
enum:
- bold
- underline
- fill
example: bold
category_menu_text_align:
type: string
enum:
- left
- center
- right
example: left
visual_settings:
type: object
required:
- layout
- product_cards
- typography
- colors
- buttons
- copy
properties:
layout:
type: object
required:
- product_view
- screen_width
- drawer_settings
- override
properties:
product_view:
type: string
enum:
- grid
- list
example: grid
screen_width:
type: string
enum:
- fixed
- flex
example: fixed
drawer_settings:
type: string
enum:
- temporary
- permanent
example: permanent
modal_mode:
type: string
enum:
- basic
- precision
- enhanced
- standard
example: basic
override:
type: boolean
example: false
product_cards:
type: object
required:
- image_aspect_ratio
- image_corners
- show_icon_labels
- cart_item_spacing_style
- override
properties:
image_aspect_ratio:
type: string
enum:
- '1:1'
- '4:3'
example: '1:1'
image_corners:
type: string
enum:
- rounded
- square
example: rounded
cycle_length:
type: integer
enum:
- 7
- 10
example: 7
show_icon_labels:
type: boolean
example: false
cart_item_spacing_style:
type: string
enum:
- default
- compact
- comfortable
example: compact
override:
type: boolean
example: false
typography:
type: object
required:
- text_size
- header_font
- body_font
- link_style
- override
properties:
text_size:
type: string
enum:
- small
- medium
- large
example: small
header_font:
type: object
required:
- font_family
- font_weight
properties:
font_family:
type: string
example: Open Sand
font_weight:
type: string
example: bold
body_font:
type: object
required:
- font_family
- font_weight
properties:
font_family:
type: string
example: Open Sand
font_weight:
type: string
example: regular
link_style:
type: string
enum:
- underline
- bold
- normal
example: underline
override:
type: boolean
example: false
colors:
type: object
required:
- primary_fill
- secondary_fill
- buttons
- icons
- header_text
- body_text
- links
- dividers
- override
properties:
primary_fill:
type: string
example: '#000000'
secondary_fill:
type: string
example: '#000000'
buttons:
type: string
example: '#000000'
icons:
type: string
example: '#000000'
header_text:
type: string
example: '#000000'
body_text:
type: string
example: '#000000'
links:
type: string
example: '#000000'
dividers:
type: string
example: '#000000'
override:
type: boolean
example: false
buttons:
type: object
required:
- corner_style
- ripple_effect
- checkout_button_text
- override
properties:
corner_style:
type: string
enum:
- square
- round
- soft
example: round
ripple_effect:
type: boolean
example: false
checkout_button_text:
type: string
example: ''
override:
type: boolean
example: false
copy:
type: object
required:
- empty_cart_message
- error_message
properties:
empty_cart_message:
type: string
example: ''
error_message:
type: string
example: ''
protocol_settings:
type: object
required:
- mode
properties:
mode:
type: string
enum:
- basic
- precision
- enhanced
- standard
example: basic
cycle_length:
type:
- integer
- 'null'
enum:
- 7
- 10
example: 7
responses:
'200':
description: Returns the updated PackBuilderSetting object.
content:
application/json:
schema:
type: object
properties:
pack_builder_settings:
$ref: '#/components/schemas/PackBuilderSetting'
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
description: Validation error response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error response.
delete:
tags:
- Pack Builder Settings
security:
- bearerAuth: []
summary: Delete a pack builder settings
operationId: deletePackBuilderSettings
description: Delete a PackBuilderSettings object.
parameters:
- $ref: '#/components/parameters/IdParameter'
- in: query
name: q
description: For internal users only. Use Query DSL *query_string* syntax to send client id.
schema:
type: string
responses:
'204':
$ref: '#/components/responses/204ConfirmDeletion'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error response.
components:
schemas:
ErrorModel:
title: Error Model
description: An error response from the OK Capsule API
type: object
properties:
error:
title: Error Model Content
type: object
description: Error details object
required:
- message
properties:
errorCode:
description: For some errors that could be handled programmatically, a short string indicating the error code.
maxLength: 5000
type: string
example: RESOURCE_NOT_FOUND
message:
description: A human-readable message providing more details about the error.
maxLength: 40000
type: string
example: The requested resource was not found
message:
description: Top-level error message (present in some error responses)
type: string
example: Internal Server Error
required:
- error
PackBuilderSetting:
allOf:
- type: object
required:
- id
- pack_builder_id
- category_settings
- visual_settings
- protocol_settings
properties:
id:
type: string
format: uuid
example: 965c5b6e-d191-4287-9c42-fb52e36c7433
pack_builder_id:
type: string
example: 47e4f05e-dc3c-4353-9dec-64139c65cddf
category_settings:
type: object
required:
- enable_product_categories
- category_selection_behavior
- category_menu_selection_behavior
- category_menu_text_align
properties:
enable_product_categories:
type: boolean
example: true
category_selection_behavior:
type: string
enum:
- scroll
- filter
example: scroll
category_menu_selection_behavior:
type: string
enum:
- bold
- underline
- fill
example: bold
category_menu_text_align:
type: string
enum:
- left
- center
- right
example: left
visual_settings:
type: object
required:
- layout
- product_cards
- typography
- colors
- buttons
- copy
properties:
layout:
type: object
required:
- product_view
- screen_width
- drawer_settings
- override
properties:
product_view:
type: string
enum:
- grid
- list
example: grid
screen_width:
type: string
enum:
- fixed
- flex
example: fixed
drawer_settings:
type: string
enum:
- temporary
- permanent
example: permanent
modal_mode:
type: string
enum:
- basic
- precision
- enhanced
- standard
example: basic
override:
type: boolean
example: false
product_cards:
type: object
required:
- image_aspect_ratio
- image_corners
- show_icon_labels
- cart_item_spacing_style
- override
properties:
image_aspect_ratio:
type: string
enum:
- '1:1'
- '4:3'
example: '1:1'
image_corners:
type: string
enum:
- rounded
- square
example: rounded
cycle_length:
type: integer
enum:
- 7
- 10
example: 7
show_icon_labels:
type: boolean
example: false
cart_item_spacing_style:
type: string
enum:
- default
- compact
- comfortable
example: compact
override:
type: boolean
example: false
typography:
type: object
required:
- text_size
- header_font
- body_font
- link_style
- override
properties:
text_size:
type: string
enum:
- small
- medium
- large
example: small
header_font:
type: object
required:
- font_family
- font_weight
properties:
font_family:
type: string
example: Open Sand
font_weight:
type: string
example: bold
body_font:
type: object
required:
- font_family
- font_weight
properties:
font_family:
type: string
example: Open Sand
font_weight:
type: string
example: regular
link_style:
type: string
enum:
- underline
- bold
- normal
example: underline
override:
type: boolean
example: false
colors:
type: object
required:
- primary_fill
- secondary_fill
- buttons
- icons
- header_text
- body_text
- links
- dividers
- override
properties:
primary_fill:
type: string
example: '#000000'
secondary_fill:
type: string
example: '#000000'
buttons:
type: string
example: '#000000'
icons:
type: string
example: '#000000'
header_text:
type: string
example: '#000000'
body_text:
type: string
example: '#000000'
links:
type: string
example: '#000000'
dividers:
type: string
example: '#000000'
override:
type: boolean
example: false
buttons:
type: object
required:
- corner_style
- ripple_effect
- checkout_button_text
- override
properties:
corner_style:
type: string
e
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ok-capsule/refs/heads/main/openapi/ok-capsule-pack-builder-settings-api-openapi.yml