Clyde Orders API

openapi: 3.2.0
info:
  title: Clyde Orders API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 9 operation(s) read from 11 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Clyde has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 9
    pages-with-code: 0
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.joinclyde.com/reference/products-1
  - https://docs.joinclyde.com/reference/createclaim
  - https://docs.joinclyde.com/reference/createorder
  - https://docs.joinclyde.com/reference/updateorder
  - https://docs.joinclyde.com/reference/createproduct
  - https://docs.joinclyde.com/reference/updateproduct
  - https://docs.joinclyde.com/reference/updatevoucher
  - https://docs.joinclyde.com/reference/createproducts
  - https://docs.joinclyde.com/reference/createtaxonomy
  - https://docs.joinclyde.com/reference/createvouchers
  - https://docs.joinclyde.com/reference/addtaxonomyterm
servers:
- url: https://api.joinclyde.com
tags:
- name: Orders
paths:
  /orders:
    post:
      operationId: post_orders
      tags:
      - Orders
      summary: Create Order
      description: Creates a new order. The request body must contain an id used to reference the order, which should correspond to the order ID in your order management system.
      x-source: https://docs.joinclyde.com/reference/createorder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostOrdersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOrdersResponse'
      x-evidence:
        kind: documentation
  /orders/{orderId}:
    put:
      operationId: put_orders_orderId
      tags:
      - Orders
      summary: Update Order
      description: Update various properties of an order using this route. Only provided fields will be updated.
      x-source: https://docs.joinclyde.com/reference/updateorder
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutOrdersOrderidRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutOrdersOrderidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PutOrdersOrderidRequest:
      type: object
      properties:
        data:
          type: object
          description: Top‑level object containing the order data
        data.type:
          type: string
          description: Must be "order"
        data.attributes:
          type: object
          description: Attributes to update on the order
        data.attributes.merchantReference1:
          type: string
          description: Merchant reference
        data.attributes.sendNotificationEmail:
          type: boolean
          description: Whether to send a notification email
        data.attributes.customer:
          type: object
          description: Customer object (all fields updatable)
        data.attributes.contractSales:
          type: array
          description: Array of contract sales to update or add
        data.attributes.lineItems:
          type: array
          description: Array of line items to update or add
      required:
      - data
      - data.type
      - data.attributes
    PostOrdersResponse:
      type: object
      properties:
        eligible:
          type: boolean
          description: Does this order contain a line item eligible for a contract sale
        daysLeft:
          type: number
          description: Days remaining to purchase an eligible contract on this order
        link:
          type: string
          description: Direct link for end customers to purchase a contract associated with this order
        waitingFor:
          type: string
          description: Outstanding date needed to begin eligibility window countdown; values "shipment", "delivery", or "null"
    PostOrdersRequest:
      type: object
      properties:
        data:
          type: object
          description: Top‑level object containing all of the request data
        data.type:
          type: string
          description: Must be "order"
        data.id:
          type: string
          description: Order ID from your system
        data.attributes:
          type: object
          description: Order attributes
        data.attributes.merchantReference1:
          type: string
        data.attributes.merchantReference2:
          type: string
        data.attributes.customer:
          type: object
        data.attributes.customer.email:
          type: string
        data.attributes.customer.phone:
          type: string
        data.attributes.customer.firstName:
          type: string
        data.attributes.customer.lastName:
          type: string
        data.attributes.customer.address1:
          type: string
        data.attributes.customer.address2:
          type: string
        data.attributes.customer.city:
          type: string
        data.attributes.customer.province:
          type: string
        data.attributes.customer.zip:
          type: string
        data.attributes.customer.country:
          type: string
        data.attributes.customer.addressType:
          type: string
        data.attributes.contractSales:
          type: array
          description: Array of contract sales
        data.attributes.contractSales[].lineItemId:
          type: string
        data.attributes.contractSales[].productSku:
          type: string
        data.attributes.contractSales[].contractSku:
          type: string
        data.attributes.contractSales[].productPrice:
          type: number
        data.attributes.contractSales[].contractPrice:
          type: number
        data.attributes.lineItems:
          type: array
        data.attributes.lineItems[].id:
          type: string
        data.attributes.lineItems[].productSku:
          type: string
        data.attributes.lineItems[].price:
          type: number
        data.attributes.lineItems[].quantity:
          type: integer
        data.attributes.lineItems[].shipDate:
          type: string
          description: Date in UTC
        data.attributes.orderSource:
          type: string
        data.attributes.orderDate:
          type: string
          description: Date in UTC
      required:
      - data
      - data.type
      - data.id
      - data.attributes
    PutOrdersOrderidResponse:
      type: object
      properties:
        default:
          type: object
          description: Standard response object