The Categories API from OK Capsule — 4 operation(s) for categories.
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-categories-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
description: '## Overview
The OK Capsule API enables you to programmatically create supplement orders, manage consumers, and track shipments. It is a REST API that accepts JSON requests, returns JSON responses, and uses standard HTTP methods and status codes.
**All requests must be made over HTTPS.**
📚 **Additional Resources:** [Getting Started Guide](https://docs.okcapsule.app/docs/getting-started) | [Recipes & Examples](https://docs.okcapsule.app/docs/category/recipes)
## Getting Started
> **New to OK Capsule API?** Account and brand setup must be completed before contacting OK Capsule about API credentials. If you have not set up your account and brand yet, start with the [Getting Started Guide](https://docs.okcapsule.app/docs/getting-started) before proceeding.
1. **Set up your account** - Your OK Capsule account must be created and active
2. **Set up your brand** - At least one Product Line must be configured in your account
3. **Contact OK Capsule about API credentials** - Reach out to your OK Capsule representative once account and brand setup are complete
4. **Authenticate** - POST to `/v2/authentication/token` to get an access token
5. **List products** - GET `/v2/products` to see available supplements
6. **Create an order** - POST to `/v2/orders` with consumer and product details
7. **Track fulfillment** - Monitor order status and shipping via `/v2/orders` and `/v2/fulfillments`
## Environments
| Environment | Purpose | Notes |
|-------------|---------|-------|
| **Production** | Live orders | Real fulfillment and shipping |
| **Stage** | Testing | Test data only, no real shipments |
⚠️ Users and data are environment-specific. Stage credentials do not work in Production.
## Core Concepts
| Term | Route | Description |
|------|-------|-------------|
| **Client** | `/v2/clients` | Your organization (business partner submitting orders) |
| **Consumer** | `/v2/consumers` | Your end customer who receives supplements |
| **Product** | `/v2/products` | A client-specific instance of an OKC Product with custom branding |
| **Order** | `/v2/orders` | A request to fulfill supplements for a consumer |
| **Order Line** | — | A set of pouches within an order (e.g., 30-day supply) |
| **Pouch** | — | An individual daily packet of supplements |
| **Fulfillment** | `/v2/fulfillments` | Shipping, tracking, and delivery information for an order |
| **Assembly** | `/v2/assemblies` | A client''s predefined bundle of products (commonly called a "pack") |
| **Product Line** | `/v2/product-lines` | A client''s marketing brand (appears on packaging) |
| **OKC Product** | — | A supplement in the OK Capsule master catalog (what OKC purchases from vendors) |
| **User** | `/v2/users` | An authorized person who accesses the API or portal |
| **Contact** | `/v2/contacts` | A person associated with a client, managed for communication purposes |'
version: 2.0.0
title: OKC core API V2 Categories 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: Categories
paths:
/v2/pack-builders/categories:
post:
tags:
- Categories
security:
- bearerAuth: []
summary: Create standalone category
operationId: createCategory
description: Create standalone category.
parameters:
- 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_name
- position
description: Create a product category for organizing products
properties:
category_name:
type: string
description: Name of the category
example: Energy & Focus
position:
type: integer
minimum: 0
description: Display order position (0-indexed)
example: 0
product_line_id:
type: string
format: uuid
description: Product line this category belongs to
example: 5662a242-5063-4d6b-864b-d0873179c82d
pack_builder_id:
type: string
format: uuid
description: Pack builder this category belongs to
example: e640d058-ecda-4f48-ba2f-c0a59804f36f
example:
category_name: Energy & Focus
position: 0
x-examples:
required-only:
summary: Create with required fields only
value:
category_name: Energy & Focus
position: 0
with-product-line:
summary: Create category for a product line
value:
category_name: Sleep & Recovery
position: 1
product_line_id: 5662a242-5063-4d6b-864b-d0873179c82d
with-pack-builder:
summary: Create category for a pack builder
value:
category_name: Immunity
position: 2
pack_builder_id: e640d058-ecda-4f48-ba2f-c0a59804f36f
examples:
CategorySample:
$ref: '#/components/examples/CategorySample'
CategoryAttachedSample:
$ref: '#/components/examples/CategoryAttachedSample'
responses:
'201':
description: Returns an added Category object.
content:
application/json:
schema:
type: object
properties:
category:
$ref: '#/components/schemas/PackBuilderCategory'
'422':
$ref: '#/components/responses/422ValidationError'
default:
$ref: '#/components/responses/UnknownError'
get:
tags:
- Categories
security:
- bearerAuth: []
summary: List all categories
operationId: listCategories
description: 'List all categories.
'
parameters:
- $ref: '#/components/parameters/LimitParameters'
- $ref: '#/components/parameters/CursorParameters'
- $ref: '#/components/parameters/SortByParameters'
- $ref: '#/components/parameters/QueryParameters'
responses:
'200':
description: Search results matching criteria
content:
application/json:
schema:
type: object
required:
- categories
properties:
categories:
type: array
items:
$ref: '#/components/schemas/PackBuilderCategory'
default:
$ref: '#/components/responses/UnknownError'
/v2/pack-builders/categories/{id}:
put:
tags:
- Categories
security:
- bearerAuth: []
summary: Update a category
operationId: updateCategory
description: Update a category.
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
description: Update a product category. All fields optional.
properties:
category_name:
type: string
description: Name of the category
example: Sleep & Recovery
position:
type: integer
minimum: 0
description: Display order position (0-indexed)
example: 1
product_line_id:
type: string
format: uuid
description: Product line this category belongs to
example: 5662a242-5063-4d6b-864b-d0873179c82d
pack_builder_id:
type: string
format: uuid
description: Pack builder this category belongs to
example: e640d058-ecda-4f48-ba2f-c0a59804f36f
example:
category_name: Updated Category Name
x-examples:
rename:
summary: Rename category
value:
category_name: Sleep & Recovery
reorder:
summary: Change position
value:
position: 3
complete:
summary: Update all fields
value:
category_name: Sleep & Recovery
position: 2
product_line_id: 5662a242-5063-4d6b-864b-d0873179c82d
responses:
'200':
description: Returns the updated Category object.
content:
application/json:
schema:
type: object
properties:
category:
$ref: '#/components/schemas/PackBuilderCategory'
'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:
- Categories
security:
- bearerAuth: []
summary: Delete a category
operationId: deleteCategory
description: Delete a category.
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.
/v2/pack-builders/categories/{id}/products:
post:
tags:
- Categories
security:
- bearerAuth: []
summary: Add a client product to category
operationId: addProductsToCategory
description: 'Add a client product to category.
'
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:
- client_product_id
- position
description: Add a product to a pack builder category with position
properties:
client_product_id:
type: string
format: uuid
description: ID of the client product to add
example: 6d28a691-1d4c-48fb-8c18-23e3557b1e05
position:
type: integer
minimum: 0
description: Display order position within the category
example: 0
example:
client_product_id: 6d28a691-1d4c-48fb-8c18-23e3557b1e05
position: 0
examples:
PackBuilderCategorySample:
$ref: '#/components/examples/PackBuilderCategoryProductsSample'
responses:
'201':
description: Returns an added Client Product to Category object.
content:
application/json:
schema:
type: object
properties:
pack_builder_categories_product:
$ref: '#/components/schemas/PackBuilderCategoriesClientProduct'
'422':
$ref: '#/components/responses/422ValidationError'
default:
$ref: '#/components/responses/UnknownError'
/v2/pack-builders/categories/{id}/products/{productId}:
delete:
tags:
- Categories
security:
- bearerAuth: []
summary: Delete a product belongs to category
operationId: removeProductFromCategory
description: Delete a product belongs to category.
parameters:
- $ref: '#/components/parameters/IdParameter'
- in: path
name: productId
required: true
schema:
type: string
minimum: 1
- 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:
PackBuilderCategoriesClientProduct:
allOf:
- type: object
required:
- category_id
- client_product_id
- client_product_position
- client_product
properties:
category_id:
type: string
format: uuid
example: d68bc04b-5261-4055-9c64-c81e4cbb871e
client_product_id:
type: string
format: uuid
example: 29f24a23-68dd-41bb-9aba-f958c10c7d39
client_product_position:
type: number
example: 2
client_product:
type: object
required:
- id
- product_line_id
- name
- product_name
properties:
id:
type: string
format: uuid
example: 3ab920e6-9d59-4f33-aea0-5045f726dafb
product_line_id:
type: string
format: uuid
example: 3ab920e6-9d59-4f33-aea0-5045f726dafb
name:
type: string
example: SP-0084
product_name:
type: string
example: Vegan Women's pack (energy+joint)
position:
type: number
example: 2
ValidationError:
type: object
title: Validation Error
required:
- message
- errors
description: A validation error response from the OK Capsule API (Joi validation)
properties:
message:
description: A human-readable message indicating a validation error occurred.
maxLength: 40000
type: string
example: Validation error
errors:
description: An array of validation errors from Joi schema validation
type: array
items:
type: object
required:
- message
- type
properties:
message:
description: A human-readable message providing more details about the validation error.
type: string
example: '''business_name'' is required'
type:
description: The Joi validation type that failed.
type: string
example: any.required
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
PackBuilderCategory:
allOf:
- allOf:
- type: object
required:
- created_at
- updated_at
properties:
created_at:
type: string
format: date-time
readOnly: true
example: '2023-03-20T09:12:28Z'
updated_at:
type: string
format: date-time
readOnly: true
example: '2023-03-20T09:12:28Z'
- type: object
required:
- id
- client_id
- product_line_id
- category_name
properties:
id:
type: string
format: uuid
example: 69d58301-84c2-447d-9064-3326d14beed7
client_id:
type: string
format: uuid
example: 29f24a23-68dd-41bb-9aba-f958c10c7d39
product_line_id:
type: string
format: uuid
example: 4eecd79f-a4a5-4b47-a454-1e32097e5ac0
category_name:
type: string
example: Energy
position:
type: number
example: 2
- type: object
required:
- created_at
- updated_at
properties:
created_at:
type: string
format: date-time
readOnly: true
example: '2023-03-20T09:12:28Z'
updated_at:
type: string
format: date-time
readOnly: true
example: '2023-03-20T09:12:28Z'
parameters:
SortByParameters:
in: query
name: sort_by
description: Sort values by a specific property. See available sort by values in the table.
schema:
type: string
QueryParameters:
in: query
name: q
description: Use Query DSL *query_string* syntax
schema:
type: string
LimitParameters:
in: query
name: limit
description: Number of results to return. Default 50, max 250.
required: false
schema:
type: integer
minimum: 1
maximum: 250
CursorParameters:
in: query
name: cursor
description: Return results before/after a specific record.
schema:
type: string
IdParameter:
in: path
name: id
required: true
schema:
type: string
minimum: 1
responses:
422ValidationError:
description: Validation error response.
content:
application/json:
schema:
type: object
title: Validation Error
required:
- message
- errors
description: A validation error response from the OK Capsule API (Joi validation)
properties:
message:
description: A human-readable message indicating a validation error occurred.
maxLength: 40000
type: string
example: Validation error
errors:
description: An array of validation errors from Joi schema validation
type: array
items:
type: object
required:
- message
- type
properties:
message:
description: A human-readable message providing more details about the validation error.
type: string
example: '''business_name'' is required'
type:
description: The Joi validation type that failed.
type: string
example: any.required
204ConfirmDeletion:
description: Confirms resource deletion.
UnknownError:
description: Error response.
content:
application/json:
schema:
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
examples:
PackBuilderCategoryProductsSample:
summary: Add a client product to category
value:
client_product_id: 6d28a691-1d4c-48fb-8c18-23e3557b1e05
position: 2
CategorySample:
summary: Creates a category.
value:
category_name: Sleep
position: 2
CategoryAttachedSample:
summary: Creates a category and attach to a PackBuilder.
value:
category_name: Sleep
position: 2
product_line_id: 5662a242-5063-4d6b-864b-d0873179c82d
pack_builder_id: e640d058-ecda-4f48-ba2f-c0a59804f36f
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT