Traffic Parrot Orders API

The Orders API from Traffic Parrot — 2 operation(s) for orders.

Operations 3

GET /orders List today's orders #
POST /orders Place an order #
GET /orders/{orderId} Fetch one order #

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/trafficparrot:trafficparrot-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

trafficparrot-orders-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orders API
  version: 1.0.0
  description: A small orders API used by the Traffic Parrot tutorial "How to generate an API mock from an OpenAPI spec".
servers:
- url: http://localhost:8081
tags:
- name: Orders
paths:
  /orders:
    get:
      summary: List today's orders
      operationId: listOrders
      responses:
        '200':
          description: The orders placed today, newest first
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'
              examples:
                today:
                  summary: Two orders placed today
                  externalValue: https://trafficparrot.com/tutorials/files/generate-api-mock-from-openapi-spec/orders.json
      tags:
      - Orders
    post:
      summary: Place an order
      operationId: placeOrder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewOrder'
            example:
              customerId: cus_42
              items:
              - sku: TULIP-RED
                quantity: 12
      responses:
        '201':
          description: The order was accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
              example:
                id: '1003'
                customerId: cus_42
                status: accepted
                items:
                - sku: TULIP-RED
                  quantity: 12
                total: '30.00'
      tags:
      - Orders
  /orders/{orderId}:
    get:
      summary: Fetch one order
      operationId: getOrder
      parameters:
      - name: orderId
        in: path
        required: true
        description: The order id, as returned when the order was placed
        schema:
          type: string
          example: '1001'
      responses:
        '200':
          description: The order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
              examples:
                settled:
                  $ref: '#/components/examples/SettledOrder'
        '404':
          description: There is no order with that id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: order_not_found
                message: There is no order with that id
      tags:
      - Orders
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
    NewOrder:
      type: object
      required:
      - customerId
      - items
      properties:
        customerId:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/OrderLine'
    OrderLine:
      type: object
      required:
      - sku
      - quantity
      properties:
        sku:
          type: string
          example: TULIP-RED
        quantity:
          type: integer
          minimum: 1
          example: 12
    Order:
      type: object
      required:
      - id
      - customerId
      - status
      - items
      - total
      properties:
        id:
          type: string
          example: '1001'
        customerId:
          type: string
          example: cus_42
        status:
          type: string
          enum:
          - accepted
          - settled
          - cancelled
        items:
          type: array
          items:
            $ref: '#/components/schemas/OrderLine'
        total:
          type: string
          description: Decimal amount in GBP
          example: '42.00'
  examples:
    SettledOrder:
      summary: An order that has been paid for and shipped
      value:
        id: '1001'
        customerId: cus_42
        status: settled
        items:
        - sku: TULIP-RED
          quantity: 12
        - sku: ROSE-WHITE
          quantity: 6
        total: '42.00'