> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Request an Integration

> Ask us to build an integration we don't support yet. We open a ticket and follow up with you.



## OpenAPI

````yaml post /integration-requests
openapi: 3.1.0
info:
  description: >

    Trackstar is a Unified API that provides standard endpoints for Supply Chain
    Logistics. We currently offer an API for Warehouse Management Systems (WMS).
  title: Trackstar API
  version: 0.1.0
servers:
  - description: Trackstar API
    url: https://production.trackstarhq.com
security: []
tags: []
externalDocs:
  description: Trackstar API Documentation
  url: https://docs.trackstarhq.com
paths:
  /integration-requests:
    post:
      summary: Request an Integration
      description: >-
        Ask us to build an integration we don't support yet. We open a ticket
        and follow up with you.
      operationId: post_POST__integration-requests
      parameters:
        - in: header
          name: x-trackstar-api-key
          description: Your organization-level Trackstar API key.
          schema:
            type: string
            example: <x-trackstar-api-key>
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationRequestBodySchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationRequestResponseSchema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
components:
  schemas:
    IntegrationRequestBodySchema:
      type: object
      properties:
        integration_type:
          type: string
          enum:
            - wms
            - cart
            - carrier
          description: ''
        integration_name:
          type: string
          description: ''
        integration_contact_email:
          type:
            - string
            - 'null'
          description: ''
        brand_name:
          type:
            - string
            - 'null'
          description: ''
        brand_contact_email:
          type:
            - string
            - 'null'
          description: ''
        api_docs_url:
          type:
            - string
            - 'null'
          description: ''
        api_docs_via_email:
          type: boolean
          description: ''
          example: true
        flows:
          type: array
          minItems: 1
          description: >-
            The flows you need from this integration. For wms, one of:
            read_inventory, read_products, read_orders, read_inbounds,
            read_returns, read_warehouses, create_order, cancel_order,
            create_product, create_inbound, create_return. For cart and carrier,
            the action names that type supports. Pass "not_sure" if you do not
            know yet, and we will follow up. Call GET
            /integration-requests/flows for the current list.
          example:
            - read_orders
            - read_inventory
          items:
            type: string
            description: ''
        prod_creds_url:
          type:
            - string
            - 'null'
          description: ''
        sandbox_creds_url:
          type:
            - string
            - 'null'
          description: ''
        notes:
          type:
            - string
            - 'null'
          description: ''
      required:
        - flows
        - integration_name
        - integration_type
      additionalProperties: false
      title: IntegrationRequestBodySchema
    IntegrationRequestResponseSchema:
      type: object
      properties:
        success:
          type: boolean
          description: ''
          example: true
      required:
        - success
      additionalProperties: false
      title: IntegrationRequestResponseSchema
    ValidationError:
      properties:
        error:
          type: string
        detail:
          type: object
          properties:
            <location>:
              type: object
              properties:
                <field_name>:
                  type: array
                  items:
                    type: string
      required:
        - error
      type: object
      title: ValidationError

````