openapi: 3.0.3
info:
  title: USPTO Bulk Data Storage System (BDSS) Appeals Status API
  version: '1.0'
  description: 'USPTO ODP Bulk Data API. Exposes the Bulk Data Storage System (BDSS) — search and download

    patent and trademark bulk datasets (bibliographic, assignment, classification, office-action

    weekly archives) as Entire Datasets (10-year increments) or Delta Datasets (daily increments)

    in XML/JSON. Does not support general filter/limit/offset/order_by database queries.

    '
  contact:
    name: USPTO API Help
    email: APIhelp@uspto.gov
servers:
- url: https://api.uspto.gov
  description: USPTO Open Data Portal
security:
- ApiKeyAuth: []
tags:
- name: Status
  description: Trademark case status
paths:
  /ts/cd/casestatus/sn{serialNumber}/info.xml:
    get:
      tags:
      - Status
      summary: Get Case Status By Serial Number XML
      operationId: getCaseStatusBySerialNumberXml
      parameters:
      - name: serialNumber
        in: path
        required: true
        schema:
          type: string
          pattern: ^[0-9]{8}$
      responses:
        '200':
          description: Case status in ST.66 XML
          content:
            application/xml:
              schema:
                type: string
  /ts/cd/casestatus/sn{serialNumber}/info.json:
    get:
      tags:
      - Status
      summary: Get Case Status By Serial Number JSON
      operationId: getCaseStatusBySerialNumberJson
      parameters:
      - name: serialNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Case status JSON
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrademarkCase'
  /ts/cd/casestatus/rn{registrationNumber}/info.xml:
    get:
      tags:
      - Status
      summary: Get Case Status By Registration Number XML
      operationId: getCaseStatusByRegistrationNumberXml
      parameters:
      - name: registrationNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ST.66 XML
          content:
            application/xml:
              schema:
                type: string
  /ts/cd/casestatus/rn{registrationNumber}/info.json:
    get:
      tags:
      - Status
      summary: Get Case Status By Registration Number JSON
      operationId: getCaseStatusByRegistrationNumberJson
      parameters:
      - name: registrationNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Case status JSON
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrademarkCase'
  /ts/cd/casestatus/rf{referenceNumber}/info.xml:
    get:
      tags:
      - Status
      summary: Get Case Status By Reference Number XML
      operationId: getCaseStatusByReferenceNumberXml
      parameters:
      - name: referenceNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ST.66 XML
          content:
            application/xml:
              schema:
                type: string
  /ts/cd/casestatus/ir{internationalRegistrationNumber}/info.xml:
    get:
      tags:
      - Status
      summary: Get Case Status By International Registration Number XML
      operationId: getCaseStatusByIrNumberXml
      parameters:
      - name: internationalRegistrationNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ST.66 XML
          content:
            application/xml:
              schema:
                type: string
  /ts/cd/casestatus/sn{serialNumber}/info.st96.xml:
    get:
      tags:
      - Status
      summary: Get Case Status ST.96 By Serial Number
      operationId: getCaseStatusBySerialNumberSt96
      parameters:
      - name: serialNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ST.96 XML
          content:
            application/xml:
              schema:
                type: string
components:
  schemas:
    TrademarkCase:
      type: object
      properties:
        serialNumber:
          type: string
        registrationNumber:
          type: string
        markIdentification:
          type: string
        statusCode:
          type: string
        statusDescription:
          type: string
        statusDate:
          type: string
          format: date
        filingDate:
          type: string
          format: date
        registrationDate:
          type: string
          format: date
        applicationFilingBasis:
          type: string
        owners:
          type: array
          items:
            type: object
            properties:
              partyName:
                type: string
              partyType:
                type: string
              addressLine:
                type: string
              cityName:
                type: string
              geographicRegionName:
                type: string
              countryCode:
                type: string
              legalEntityType:
                type: string
        goodsServices:
          type: array
          items:
            type: object
            properties:
              internationalClass:
                type: string
              usClass:
                type: string
              goodsServicesText:
                type: string
        prosecutionHistory:
          type: array
          items:
            type: object
            properties:
              eventCode:
                type: string
              eventDescription:
                type: string
              eventDate:
                type: string
                format: date
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY