OK Capsule Onboarding API

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 Onboarding 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: Onboarding
paths:
  /v2/onboarding/address:
    post:
      tags:
      - Onboarding
      security:
      - bearerAuth: []
      summary: Add billing address to client
      operationId: onboardingAddAddress
      description: Add billing address to client.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - address
              description: Add billing address during client onboarding
              properties:
                billing_contact_firstname:
                  type: string
                  description: Billing contact first name
                  example: Jane
                billing_contact_lastname:
                  type: string
                  description: Billing contact last name
                  example: Smith
                address:
                  type: object
                  required:
                  - address1
                  - city
                  - province_name
                  - country_name
                  - postal_code
                  properties:
                    addressed_to:
                      type: string
                      description: Name on address
                      example: Wellness Supplements Inc.
                    address1:
                      type: string
                      maxLength: 100
                      example: 123 Business Park Dr
                    address2:
                      type: string
                      maxLength: 100
                      example: Suite 100
                    city:
                      type: string
                      example: Austin
                    province_name:
                      type: string
                      example: Texas
                    country_name:
                      type: string
                      example: United States
                    postal_code:
                      type: string
                      example: '78701'
              example:
                address:
                  address1: 123 Business Park Dr
                  city: Austin
                  province_name: Texas
                  country_name: United States
                  postal_code: '78701'
              x-examples:
                address-only:
                  summary: Add address without billing contact
                  value:
                    address:
                      address1: 123 Business Park Dr
                      city: Austin
                      province_name: Texas
                      country_name: United States
                      postal_code: '78701'
                complete:
                  summary: Add address with billing contact
                  value:
                    billing_contact_firstname: Jane
                    billing_contact_lastname: Smith
                    address:
                      addressed_to: Wellness Supplements Inc.
                      address1: 123 Business Park Dr
                      address2: Suite 100
                      city: Austin
                      province_name: Texas
                      country_name: United States
                      postal_code: '78701'
            examples:
              OnboardingAddressSample:
                $ref: '#/components/examples/OnboardingAddressSample'
      responses:
        '201':
          description: Returns an added Address object.
          content:
            application/json:
              schema:
                type: object
                properties:
                  client:
                    $ref: '#/components/schemas/Address'
        '422':
          $ref: '#/components/responses/422ValidationError'
        default:
          $ref: '#/components/responses/UnknownError'
components:
  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
    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
  schemas:
    Address:
      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
          description: 'Address response object. Note: The entity ID field name varies based on context:

            - For client addresses: `client_id`

            - For consumer addresses: `consumer_id`

            - For contact addresses: `contact_id`

            '
          required:
          - id
          - is_default
          properties:
            id:
              type: string
              format: uuid
              readOnly: true
              example: d290f1ee-6c54-4b01-90e6-d701748f0851
            client_id:
              type: string
              format: uuid
              description: Present for client addresses
              example: d290f1ee-6c54-4b01-90e6-d701748f0851
            consumer_id:
              type: string
              format: uuid
              description: Present for consumer addresses
              example: d290f1ee-6c54-4b01-90e6-d701748f0851
            contact_id:
              type: string
              format: uuid
              description: Present for contact addresses
              example: d290f1ee-6c54-4b01-90e6-d701748f0851
            is_default:
              type: boolean
              example: true
            address_type:
              type: string
              enum:
              - shipping
              - billing
              - legal
              - return
              example: shipping
            addressed_to:
              type: string
              example: Homer Simpson
            address1:
              type: string
              example: 742 Evergreen Terrace
            address2:
              type: string
              example: Apt. 23
            city:
              type: string
              example: Springfield
            province_name:
              type: string
              example: Ohio
            province_code:
              type: string
              format: ISO 3166-2
              example: OH
            country_name:
              type: string
              example: United States
            country_code:
              type: string
              format: ISO 3166-1 alpha-2
              example: US
            postal_code:
              type: string
              example: '45501'
            phone_number:
              type: string
              format: E.164
              example: '+12133734253'
            crm_id:
              type: string
              x-internal: true
              description: Internal use only.
              example: ABCDE12587AHSNNHS
      - 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'
  examples:
    OnboardingAddressSample:
      summary: Add client billing address
      value:
        billing_contact_firstname: Jane
        billing_contact_lastname: Smith
        address:
          addressed_to: Jane Smith
          address1: 6515 Sunset Blvd
          address2: Suite 320
          city: Los Angeles
          province_name: California
          country_name: United States
          postal_code: '90028'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT