openapi: 3.0.0
x-stoplight:
  id: qbomxbd9d2tv8
info:
  title: Product-NetPrice
  version: '1.1'
  contact:
    url: https://se.com
    name: Stanislav PEYCHEV
    email: stanislav.peychev@se.com
  description: Get the Net Price of a requested amount of the SE product based on the customer ID.
servers:
  - url: https://api.qa.se.com/v1/customer-journey/distributor/product-netprice
    description: QA/test environment
  - url: https://api.se.com/v1/customer-journey/distributor/product-netprice
    description: Production server
paths:
  /product-reference:
    parameters: []
    get:
      summary: Product-Reference
      tags: []
      responses:
        '200':
          description: OK. The request has succeeded. Please proceed with parsing the response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  catalogNumber:
                    type: string
                    description: Product catalog number
                  productNumber:
                    type: string
                    description: Product number
                  productDescription:
                    type: string
                    description: Product description
                  quantity:
                    type: integer
                    description: Quantity
                  listPrice:
                    type: number
                    description: List/public price
                  netPrice:
                    type: number
                    description: Net price
                  netPriceUOM:
                    type: number
                    description: Net price unit of measure
                  totalNetPrice:
                    type: number
                    description: Total net price
                  currencyCode:
                    type: string
                    description: Currency ISO code
                  priceDate:
                    type: string
                    format: date-time
                    description: Price date
                  materialPriceGroup:
                    type: string
                    description: Material price group
                  standardLeadTime:
                    type: integer
                    description: Standard lead time
                  errorMessages:
                    type: array
                    description: Error messages
                    items:
                      type: string
                  warningMessages:
                    type: array
                    description: Warning messages
                    items:
                      type: string
                  minOrderQuantity:
                    type: integer
                    description: Minimal order quantity
                  promiseQuantity:
                    type: integer
                    description: Promise quantity
                  customsCode:
                    type: string
                    description: Customs code
              examples:
                Example - netPrice:
                  value:
                    catalogNumber: '99887766'
                    productNumber: '3389110348873'
                    productDescription: CONTATOR TRIPOLAR 9A 1NA+1NF 220VCA
                    quantity: 10
                    netPrice: 20.52
                    totalNetPrice: 785.61
                    currencyCode: BRL
                    priceDate: '2022-04-06T11:04:38Z'
                    minOrderQuantity: 1
                    customsCode: '8536699099'
                    warningMessages: []
                    errorMessages: []
            application/xml:
              schema:
                type: object
                properties: {}
            multipart/form-data:
              schema:
                type: object
                properties: {}
        '400':
          $ref: '#/components/responses/Common_Oas3_400'
        '401':
          $ref: '#/components/responses/Common_Oas3_401'
        '403':
          $ref: '#/components/responses/Common_Oas3_403'
        '404':
          $ref: '#/components/responses/Common_Oas3_404'
        '429':
          $ref: '#/components/responses/Common_Oas3_429'
        '500':
          $ref: '#/components/responses/Common_Oas3_500'
      operationId: product-reference
      parameters:
        - schema:
            type: string
            example: LXM28AU01M3X
          in: query
          description: Product Reference
          required: true
          name: catalog-number
        - schema:
            type: integer
            default: 20
          in: query
          name: quantity
          required: true
          description: Quantity
        - schema:
            type: string
            example: USD
          in: query
          name: currency-code
          description: Currency
        - schema:
            type: string
            example: '0000010000'
          in: query
          name: customer-id
          description: Customer ID
        - schema:
            type: string
            format: date
            example: '2022-04-06'
          in: query
          description: Price Date
          name: price-date
      description: Product Net Price for a specific Product reference
components:
  schemas:
    Error:
      type: object
      title: Error Response
      description: Error response returned to the consumer when an HTTP error status has occurred.
      properties:
        code:
          type: string
          example: MISSING_FIELD or 12345
          description: |-
            Service-defined error code which may be numeric or a string.

            Errors detected by the APIM platform result in the following codes.

            BAD_REQUEST (for 400)
            UNAUTHORIZED (for 401)
            FORBIDDEN (for 403)
            NOT_FOUND (for 404)
            GONE (for 410)
            PRECONDITION_FAILED (for 412)
            TOO_MANY_REQUESTS (for 429)
            INTERNAL_SERVER_ERROR (for 500)
            NOT_IMPLEMENTED (for 501)

            Any specific service validation errors would replace BAD_REQUEST.
        userMessage:
          type: string
          example: 'Required field is missing: productSku'
          description: Human-readable general description of the error.
        developerMessage:
          type: string
          description: Optional human-readable description of the error details.
          example: 'Product master API ParseException: required tag <sku> expected'
        moreInfo:
          type: string
          description: Optional link to error documentation, which has more information about the error.
          format: uri
          example: https://example.com/product-master/v1/error/12345
      required:
        - code
        - userMessage
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          refreshUrl: ''
          scopes: {}
          tokenUrl: /token
      description: OAuth2 API access token.
  responses:
    Common_Oas3_400:
      description: Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                code: BAD_REQUEST
                userMessage: Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI.
                developerMessage: Request content is malformed or exceeded structural limits
                moreInfo: https://example.com/error/123
    Common_Oas3_401:
      description: The client is not authorized to perform this request because its identity has not yet been established, or the token is invalid or has expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                code: UNAUTHORIZED
                userMessage: The client is not authorized to perform this request because its identity has not yet been established, or the token is invalid or has expired.
                developerMessage: Invalid Access Token
                moreInfo: https://example.com/error/123
    Common_Oas3_403:
      description: The client does not have permission to perform the requested action e.g. POST or DELETE.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                code: FORBIDDEN
                userMessage: The client does not have permission to perform the requested action e.g. POST or DELETE.
                developerMessage: Http verb DELETE is not supported for path suffix /installed-products/track
                moreInfo: https://example.com/error/123
    Common_Oas3_404:
      description: Requested resource does not exist on the server. It is assumed that the URI is valid for this type of resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                code: NOT_FOUND
                userMessage: Requested resource does not exist on the server. It is assumed that the URI is valid for this type of resource.
                developerMessage: Records not found
                moreInfo: https://example.com/error/123
    Common_Oas3_429:
      description: Number of requests has exceeded the client's rate limits.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                code: TOO_MANY_REQUESTS
                userMessage: Number of requests has exceeded the client’s rate limits.
                developerMessage: Spike arrest violation
                moreInfo: https://example.com/error/123
    Common_Oas3_500:
      description: Requested operation encountered an unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                code: INTERNAL_SERVER_ERROR
                userMessage: Requested operation encountered an unexpected server error.
                developerMessage: Target service is unavailable, please try again later.
                moreInfo: https://example.com/error/123
security:
  - OAuth2: []