CompTeam Orders API

The Orders API from CompTeam — 6 operation(s) for orders.

GitHub OpenAPI

Operations 7

GET /api/v1/orders/ List Branch Orders #
POST /api/v1/orders/ Create Order #
GET /api/v1/orders/availability Get Order Availability #
GET /api/v1/orders/me Get My Orders #
GET /api/v1/orders/capabilities Get Order Capabilities #
POST /api/v1/orders/{order_id}/cancel Cancel My Order #
PATCH /api/v1/orders/{order_id}/status Update Order Status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/compteam-io:compteam-io-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

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 Specification

compteam-io-orders-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compteam Io Orders API
  version: 0.1.0
  description: 'Operations tagged Orders across 2 of this provider''s published API definitions: compteam-io-openapi.json, compteam-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.compteam.io
  description: C-TEAM API host serving this spec and its Swagger UI at /docs
tags:
- name: Orders
paths:
  /api/v1/orders/:
    get:
      tags:
      - Orders
      summary: List Branch Orders
      operationId: list_branch_orders_api_v1_orders__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
    post:
      tags:
      - Orders
      summary: Create Order
      operationId: create_order_api_v1_orders__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/orders/availability:
    get:
      tags:
      - Orders
      summary: Get Order Availability
      operationId: get_order_availability_api_v1_orders_availability_get
      security:
      - HTTPBearer: []
      parameters:
      - name: product_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          title: Product Id
      - name: location_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          title: Location Id
      - name: quantity
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Quantity
      - name: variant_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Variant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/orders/me:
    get:
      tags:
      - Orders
      summary: Get My Orders
      operationId: get_my_orders_api_v1_orders_me_get
      security:
      - HTTPBearer: []
      parameters:
      - name: for_kid_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: For Kid Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/orders/capabilities:
    get:
      tags:
      - Orders
      summary: Get Order Capabilities
      operationId: get_order_capabilities_api_v1_orders_capabilities_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/orders/{order_id}/cancel:
    post:
      tags:
      - Orders
      summary: Cancel My Order
      operationId: cancel_my_order_api_v1_orders__order_id__cancel_post
      security:
      - HTTPBearer: []
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Order Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/orders/{order_id}/status:
    patch:
      tags:
      - Orders
      summary: Update Order Status
      operationId: update_order_status_api_v1_orders__order_id__status_patch
      security:
      - HTTPBearer: []
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Order Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderStatusUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrderStatusUpdate:
      properties:
        status:
          type: string
          title: Status
        tracking_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Tracking Number
        override_payment_clearance:
          type: boolean
          title: Override Payment Clearance
          default: false
      type: object
      required:
      - status
      title: OrderStatusUpdate
    OrderCreate:
      properties:
        items:
          items:
            $ref: '#/components/schemas/OrderItemInput'
          type: array
          title: Items
        pickup_location_id:
          type: string
          format: uuid
          title: Pickup Location Id
        shipping_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Shipping Name
        shipping_address_line1:
          anyOf:
          - type: string
          - type: 'null'
          title: Shipping Address Line1
        shipping_address_line2:
          anyOf:
          - type: string
          - type: 'null'
          title: Shipping Address Line2
        shipping_city:
          anyOf:
          - type: string
          - type: 'null'
          title: Shipping City
        shipping_country:
          anyOf:
          - type: string
          - type: 'null'
          title: Shipping Country
        shipping_postal_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Shipping Postal Code
        payment_method:
          type: string
          title: Payment Method
          default: stripe
        for_kid_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: For Kid Id
        discount_code:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Discount Code
      type: object
      required:
      - items
      - pickup_location_id
      title: OrderCreate
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    OrderItemInput:
      properties:
        product_id:
          type: string
          format: uuid
          title: Product Id
        variant_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Variant Id
        quantity:
          type: integer
          exclusiveMinimum: 0.0
          title: Quantity
          default: 1
      type: object
      required:
      - product_id
      title: OrderItemInput
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- compteam-io-openapi.json
- compteam-io-openapi.yml