Routes to manage product lines (formerly brands).
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-product-lines-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 Product Lines 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: Product Lines
description: Routes to manage product lines (formerly brands).
paths:
/v2/product-lines:
post:
tags:
- Product Lines
security:
- bearerAuth:
- product_lines/write
summary: Creates a product line
operationId: createProductLine
description: Creates a product line.
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:
- address_id
- shipping_notification_email
- display_name
- send_tracking_to_client_shipping_contact
- send_tracking_to_consumer
properties:
address_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
shipping_notification_email:
type: string
example: email@example.com
display_name:
type: string
maxLength: 20
example: Akeso Supplements
description:
type: string
example: Healthiest supplements in the lands between
send_tracking_to_client_shipping_contact:
type: boolean
send_tracking_to_consumer:
type: boolean
box_color:
type:
- string
- 'null'
example: White
sticker_finish:
type:
- string
- 'null'
example: Matte
default_packaging_asset_group_id:
type:
- string
- 'null'
format: uuid
example: c6de9100-e8b2-4032-80e2-3743deda83d2
name:
type:
- string
- 'null'
example: Akseo
x-internal: true
description: This field is filtered for client users.
status:
type: string
enum:
- Never Launched
- On Hold
- Retired
- Shipping
- Onboarding
- Testing
- Pre-Sale
x-internal: true
description: This field is filtered for client users.
pouch_material:
type: string
enum:
- Eco/Compostable
- Plastic
example: Plastic
x-internal: true
description: This field is filtered for client users.
fulfillment_fee:
type: object
x-internal: true
description: This field is filtered for client users.
shipping_fee:
type: object
x-internal: true
description: This field is filtered for client users.
fulfillment_fee_kitting:
type: object
x-internal: true
description: This field is filtered for client users.
shipping_fee_kitting:
type: object
x-internal: true
description: This field is filtered for client users.
pamphlet_template_pages_count:
type: integer
x-internal: true
description: This field is filtered for client users.
additional_pouch_count:
type: integer
x-internal: true
description: This field is filtered for client users.
enforce_orderline_consolidation:
type:
- boolean
- 'null'
x-internal: true
description: This field is filtered for client users.
default_orderline_duration:
type:
- integer
- 'null'
x-internal: true
description: This field is filtered for client users.
pill_per_pouch_overflow_strategy:
type:
- string
- 'null'
x-internal: true
description: This field is filtered for client users.
shipping_tier:
type:
- string
- 'null'
x-internal: true
description: This field is filtered for client users.
carrier_service_group:
type:
- string
- 'null'
format: uuid
x-internal: true
description: This field is filtered for client users.
crm_id:
type: string
x-internal: true
description: This field is filtered for client users.
examples:
ProductLineFullSample:
summary: Creates product lines with all fields
$ref: '#/components/examples/ProductLineFullSample'
responses:
'201':
description: Returns a created product line.
content:
application/json:
schema:
type: object
properties:
product_line:
$ref: '#/components/schemas/ProductLine'
'422':
$ref: '#/components/responses/422ValidationError'
default:
$ref: '#/components/responses/UnknownError'
get:
tags:
- Product Lines
security:
- bearerAuth:
- product_lines/read
summary: List product lines
operationId: listProductLines
description: 'List product lines.
Filterable fields:
* name
* display_name
* status
* pouch_material
* crm_id
Sortable fields:
* display_name'
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:
- product_lines
properties:
product_lines:
type: array
items:
$ref: '#/components/schemas/ProductLine'
default:
$ref: '#/components/responses/UnknownError'
/v2/product-lines/count:
get:
tags:
- Product Lines
security:
- bearerAuth:
- product_lines/read
summary: Count of all product_lines
operationId: getProductLineTotalCount
description: 'Count of all product_lines.
Filterable fields:
* name
* display_name
* status
* pouch_material
* crm_id'
parameters:
- $ref: '#/components/parameters/QueryParameters'
responses:
'200':
description: Search results matching criteria
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/Count'
default:
$ref: '#/components/responses/UnknownError'
/v2/product-lines/{id}:
get:
tags:
- Product Lines
security:
- bearerAuth:
- product_lines/read
summary: Get a product line
operationId: getProductLine
description: Get a product line.
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
properties:
product_line:
$ref: '#/components/schemas/ProductLine'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error response.
put:
tags:
- Product Lines
security:
- bearerAuth:
- product_lines/write
summary: Update a product line
operationId: updateProductLine
description: Update a product line.
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
properties:
address_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
shipping_notification_email:
type: string
example: email@example.com
display_name:
type: string
maxLength: 20
example: Akeso Supplements
description:
type:
- string
- 'null'
example: Healthiest supplements in the lands between
send_tracking_to_client_shipping_contact:
type: boolean
send_tracking_to_consumer:
type: boolean
box_color:
type:
- string
- 'null'
example: White
sticker_finish:
type:
- string
- 'null'
example: Matte
default_packaging_asset_group_id:
type:
- string
- 'null'
format: uuid
example: c6de9100-e8b2-4032-80e2-3743deda83d2
name:
type:
- string
- 'null'
example: Akseo
x-internal: true
description: This field is filtered for client users.
status:
type: string
enum:
- Never Launched
- On Hold
- Retired
- Shipping
- Onboarding
- Testing
- Pre-Sale
x-internal: true
description: This field is filtered for client users.
pouch_material:
type: string
enum:
- Eco/Compostable
- Plastic
example: Plastic
x-internal: true
description: This field is filtered for client users.
fulfillment_fee:
type: object
x-internal: true
description: This field is filtered for client users.
shipping_fee:
type: object
x-internal: true
description: This field is filtered for client users.
fulfillment_fee_kitting:
type: object
x-internal: true
description: This field is filtered for client users.
shipping_fee_kitting:
type: object
x-internal: true
description: This field is filtered for client users.
pamphlet_template_pages_count:
type: integer
x-internal: true
description: This field is filtered for client users.
additional_pouch_count:
type: integer
x-internal: true
description: This field is filtered for client users.
enforce_orderline_consolidation:
type:
- boolean
- 'null'
x-internal: true
description: This field is filtered for client users.
default_orderline_duration:
type:
- integer
- 'null'
x-internal: true
description: This field is filtered for client users.
pill_per_pouch_overflow_strategy:
type:
- string
- 'null'
x-internal: true
description: This field is filtered for client users.
shipping_tier:
type:
- string
- 'null'
x-internal: true
description: This field is filtered for client users.
carrier_service_group:
type: string
format: uuid
x-internal: true
description: This field is filtered for client users.
crm_id:
type: string
x-internal: true
description: This field is filtered for client users.
description: Product line to add
responses:
'200':
description: Returns the updated product line.
content:
application/json:
schema:
type: object
properties:
product_line:
$ref: '#/components/schemas/ProductLine'
'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:
- Product Lines
security:
- bearerAuth:
- product_lines/write
summary: Delete a product line
operationId: deleteProductLine
description: Delete a product line.
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':
description: Confirms deletion of a product line.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error response.
/v2/product-lines/{id}/packaging-asset-groups:
get:
tags:
- Product Lines
security:
- bearerAuth:
- product_lines/read
summary: Get a Packaging Asset Group attached to product line
operationId: getPackagingAssetGroupProductLine
description: Get a Packaging Asset Group attached to product line.
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
properties:
packaging_asset_group:
$ref: '#/components/schemas/PackagingAssetGroup'
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
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
Count:
allOf:
- type: object
properties:
count:
type: number
example: 8
ProductLine:
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
properties:
id:
type: string
format: uuid
readOnly: true
example: d290f1ee-6c54-4b01-90e6-d701748f0851
client_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
status:
type:
- string
- 'null'
enum:
- Never Launched
- On Hold
- Retired
- Shipping
- Onboarding
- Testing
- Pre-Sale
example: Onboarding
address_id:
type:
- string
- 'null'
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
default_packaging_asset_group_id:
type:
- string
- 'null'
format: uuid
example: c6de9100-e8b2-4032-80e2-3743deda83d2
shipping_notification_email:
type: string
example: email@example.com
name:
type:
- string
- 'null'
example: Akseo
display_name:
type: string
example: Akeso Supplements
description:
type:
- string
- 'null'
example: Healthiest supplements in the lands between
send_tracking_to_client_shipping_contact:
type: boolean
send_tracking_to_consumer:
type: boolean
pouch_material:
type: string
enum:
- Eco/Compostable
- Plastic
example: Plastic
box_color:
type:
- string
- 'null'
example: White
sticker_finish:
type:
- string
- 'null'
example: Matte
pamphlet_template_pages_count:
type:
- integer
- 'null'
x-internal: true
description: This field is for internal use only.
additional_pouch_count:
type:
- integer
- 'null'
x-internal: true
description: This field is for internal use only.
enforce_orderline_consolidation:
type:
- boolean
- 'null'
x-internal: true
description: This field is for internal use only.
default_orderline_duration:
type:
- integer
- 'null'
x-internal: true
description: This field is for internal use only.
pill_per_pouch_overflow_strategy:
type:
- string
- 'null'
x-internal: true
description: This field is for internal use only.
shipping_tier:
type:
- string
- 'null'
x-internal: true
description: This field is for internal use only.
carrier_service_group:
type:
- string
- 'null'
format: uuid
x-internal: true
description: This field is for internal use only.
fulfillment_fee:
type:
- object
- 'null'
x-internal: true
description: This field is for internal use only.
shipping_fee:
type:
- object
- 'null'
x-internal: true
description: This field is for internal use only.
fulfillment_fee_kitting:
type:
- object
- 'null'
x-internal: true
description: This field is for internal use only.
shipping_fee_kitting:
type:
- object
- 'null'
x-internal: true
description: This field is for internal use only.
crm_id:
type:
- string
- 'null'
example: ABCDE12587AHSNNHS
x-internal: true
description: This field is for internal use only.
- 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'
PackagingAssetGroup:
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
- pamphlet_cover_image_url
- pamphlet_inside_cover_image_url
- pamphlet_back_image_url
properties:
id:
type: string
format: uuid
readOnly: true
example: d290f1ee-6c54-4b01-90e6-d701748f0851
client_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
status:
type: string
enum:
- New
- Active
- Testing
- Onboarding
- Archived
sku:
type: string
example: ABCD-1236-QWERTY
pamphlet_cover_image_url:
type: string
format: url
example: https://okc-aws-bucket.com/pamphlet_cover_image-666c1d3a-17b2-488a-951a-2caa7cf21826.jpg
pamphlet_inside_cover_image_url:
type: string
format: url
example: https://okc-aws-bucket.com/pamphlet_inside_cover_image-666c1d3a-17b2-488a-951a-2caa7cf21826.jpg
pamphlet_back_image_url:
type: string
format: url
example: https://okc-aws-bucket.com/pamphlet_back_image-666c1d3a-17b2-488a-951a-2caa7cf21826.jpg
sleeve_label_large_file_url:
type: string
format: url
example: https://okc-aws-bucket.com/sleeve_label_large_file-666c1d3a-17b2-488a-951a-2caa7cf21826.pdf
sleeve_label_small_file_url:
type: string
format: url
example: https://okc-aws-bucket.com/sleeve_label_small_file-666c1d3a-17b2-488a-951a-2caa7cf21826.pdf
pouch_label_file_url:
type: string
format: url
example: https://okc-aws-bucket.com/pouch_label_file-666c1d3a-17b2-488a-951a-2caa7cf21826.pdf
internal_name:
type: string
example: PAG-00015
x-internal: true
description: This field is for internal use only.
display_name:
type: string
example: Packaging Asset Group 00015
pamphlet_cover_page_json:
type: object
properties:
template_page_name:
type: string
example: front_cover
available_placeholders:
type: string
example: '{"pack_name", "first_name"}'
template_block_content:
type: string
example: '{{pack_name}}'
placeholder_style_data:
type: object
properties:
color:
type: string
example: '#000000'
font-family:
type: string
example: Helvetica
font-weight:
type: string
example: '700'
font-size:
type: string
example: 24pt
line-height:
type: number
example: 1
template_block_style_data:
type: object
properties:
bottom:
type: string
example: 1cm
left:
type: string
example: 0.95cm
height:
type: string
example: auto
width:
type: string
example: 10.46cm
color:
type: string
example: '#000000'
font-family:
type: string
example: Helvetica
font-weight:
type: string
example: '400'
font-size:
type: string
example: 24pt
line-height:
type: number
example: 1.2
font_family:
type: string
example: Helvetica
font_url:
type: string
pamphlet_template_size:
enum:
- sm
- lg
example: sm
custom_template_name:
type: string
example: my-custom-template-name
fulfillment_okc_product_ids:
type: array
items:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
x-internal: true
description: This field is for internal use only.
max_pouch_count:
type: number
example: 30
x-internal: true
description: This field is for internal use only.
base_packaging_asset_group_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
x-internal: true
description: This field is for internal use only.
label_group_id:
type: string
example: d290f1ee-6c54-4b01-90e6-d701748f0851
pamphlet_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
label_large_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
label_small_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
pouch_template_id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
pouch_logo_proxy:
type: string
example: proxy-logo-url
label_schema_version:
type: string
example: v2
pamphlet_schema_version:
type: string
example: v2
is_approved_by_quality:
type: boolean
example: false
x-internal: true
description: This field is for internal use only.
is_operations_ready:
type: boolean
example: false
x-internal: true
description: This field is for internal use only.
is_locked:
type: boolean
example: false
x-internal: true
description: This field is for internal use only.
- 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'
res
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ok-capsule/refs/heads/main/openapi/ok-capsule-product-lines-api-openapi.yml