B.R.M Chronographes Agent Orders API

openapi: 3.2.0
info:
  title: BRM Hub Agent Orders API
  version: 1.0.0
tags:
- name: agent-orders
paths:
  /api/agent/v1/orders:
    post:
      tags:
      - agent-orders
      summary: Prepare an order the customer must confirm by email
      operationId: route_creer_api_agent_v1_orders_post
      parameters:
      - name: idempotency-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 80
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DemandeCommande'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/agent/v1/orders/by-idempotency-key:
    get:
      tags:
      - agent-orders
      summary: Order status from the Idempotency-Key
      operationId: route_etat_par_cle_api_agent_v1_orders_by_idempotency_key_get
      parameters:
      - name: idempotency-key
        in: header
        required: true
        schema:
          type: string
          maxLength: 80
          title: Idempotency-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/agent/v1/orders/{order_id}:
    get:
      tags:
      - agent-orders
      summary: Order status (no customer data)
      operationId: route_etat_api_agent_v1_orders__order_id__get
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
          title: Order Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    Client:
      properties:
        email:
          type: string
          maxLength: 200
          title: Email
        first_name:
          type: string
          maxLength: 60
          minLength: 1
          title: First Name
        last_name:
          type: string
          maxLength: 60
          minLength: 1
          title: Last Name
        phone:
          anyOf:
          - type: string
            maxLength: 30
          - type: 'null'
          title: Phone
      type: object
      required:
      - email
      - first_name
      - last_name
      title: Client
    app__routers__agent_configurateur__Configuration:
      properties:
        model:
          type: string
          maxLength: 80
          title: Model
          description: Model slug, e.g. 'v6-44-sa'.
        options:
          items:
            type: string
          type: array
          maxItems: 40
          title: Options
          description: option_id values from GET /models/{model}.
        engraving:
          anyOf:
          - type: string
            maxLength: 24
          - type: 'null'
          title: Engraving
      type: object
      required:
      - model
      title: Configuration
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DemandeCommande:
      properties:
        configuration:
          $ref: '#/components/schemas/app__routers__agent_configurateur__Configuration'
        customer:
          $ref: '#/components/schemas/Client'
        shipping_address:
          $ref: '#/components/schemas/Adresse'
        lang:
          type: string
          maxLength: 5
          title: Lang
          default: en
        user_consent:
          type: boolean
          title: User Consent
          description: 'MUST be true: the user explicitly asked to order this watch and agreed to share their name, email and address with B.R.M for this order.'
      type: object
      required:
      - configuration
      - customer
      - shipping_address
      - user_consent
      title: DemandeCommande
    Adresse:
      properties:
        line1:
          type: string
          maxLength: 120
          minLength: 3
          title: Line1
        line2:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Line2
        postal_code:
          type: string
          maxLength: 16
          minLength: 2
          title: Postal Code
        city:
          type: string
          maxLength: 80
          minLength: 1
          title: City
        region:
          anyOf:
          - type: string
            maxLength: 60
          - type: 'null'
          title: Region
          description: State / province / region when the country uses one.
        country:
          type: string
          maxLength: 2
          minLength: 2
          title: Country
          description: ISO-3166 alpha-2, e.g. 'US'.
      type: object
      required:
      - line1
      - postal_code
      - city
      - country
      title: Adresse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer