gistfile1.txt

openapi: 3.0.0
info:
  description: DMS Partner Api Documentation
  version: "1.0.1"
  title: DMS Rest Api
  contact:
    email: [email protected]
paths:
    /lookup:
        parameters:
            - $ref: 'https://1swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
        get:
            summary: Deal Lookup
            description: Lookup a deal by dealer identifier
            parameters:
                - in: query
                  name: deal-number
                  description: Deal Number
                  required: true
                  schema:
                    type: string
                  example: AB1234
                - in: query
                  name: third-party-id
                  description: Dealer Number
                  required: true
                  schema:
                    type: string
                  example: AZ2235HHGGJHKPOL
                - in: query
                  name: dealer-store
                  description: Dealer Store
                  required: false
                  schema:
                    type: string  
                  example: 06
                - in: query
                  name: dealer-branch
                  description: Dealer Branch
                  required: false
                  schema:
                    type: string
                  example: 01
            responses:
                '200':
                    description: OK
                    content:
                        application/xml:
                          schema:
                            $ref: 'https://2swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/schemas/Deals'
                    headers:
                      - $ref: 'https://3swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
                '401':
                    description: Unauthenticated
                    headers:
                      - $ref: 'https://4swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
                '403':
                    description: Unauthorized
                    headers:
                      - $ref: 'https://5swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
                '404':
                    description: Deal not found
                    headers:
                      - $ref: 'https://6swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
    /search:
        parameters:
            - $ref: 'https://7swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
        get:
            summary: Customer Search
            description: Lookup a customer by name of VIN number
            parameters:
                - in: query
                  name: first-name
                  description: First Name
                  required: false
                  schema:
                    type: string
                  example: John
                - in: query
                  name: last-name
                  description: Last Name
                  required: false
                  schema:
                    type: string
                  example: James
                - in: query
                  name: vin
                  description: VIN Number
                  required: false
                  schema:
                    type: string  
                  example: VIN8899009900
            responses:
                '200':
                    description: OK
                    content:
                      application/xml: {}
                    headers:
                      - $ref: 'https://8swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
                '401':
                    description: Unauthenticated
                    headers:
                      - $ref: 'https://9swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
                '403':
                    description: Unauthorized
                    headers:
                      - $ref: 'https://10swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'
                '404':
                    description: Customer not found
                    headers:
                      - $ref: 'https://11swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/parameters/xCorrelationId'

components:
  parameters:
      xCorrelationId:
          in: header
          name: x-correlation-id
          required: true
          schema:
              type: string
              format: uuid
          example: a3ae5c58-6f84-40ba-b99c-6caa2512ac6b
  schemas:
    Deals:
      type: object
      properties:
        Deal:
          $ref: 'https://12swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/schemas/Deal'
    Deal:
      type: object
      properties:
        DealId:
          type: string 
          example: ABC123
        Fees:
          type: array
          items:
            $ref: 'https://13swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/schemas/Fee'
          xml:
            wrapped: true
            name: Fee
        Products:
          type: array
          items:
            $ref: 'https://14swaggerhub.np.aws.dealertrack.com/apiproxy/schema/file/DealertrackPartners/DMS-Partner-Deal-Specification/1.0.1/swagger.json#/components/schemas/Product'
          xml:
            wrapped: true
            name: Product
    Fee:
      type: object
      properties:
        Name:
          type: string 
          example: VSI Fee
        Amount:
          type: number
          example: 129.00
    Product:
      type: object
      properties:
        CostAmount:
          type: number
          example: 1.00
        UpFrontFlag:
          type: boolean
          example: true
        ProfitType:
          type: string
          example: NEW
        SaleAmount:
          type: number
          example: 1.00
        Code:
          type: string
          example: CS
        Name:
          type: string
          example: PROTECTION PLUS
        Taxable:
          type: string
          example: Y