openapi: 3.0.1
info:
  title: Price Service Webhook
  description: The Price Service Webhook supports the request of prices from another system.
  contact:
    name: Intershop Communications AG
    url: https://intershop.com
  version: 1.0.0-Beta
paths:
  /[path to product price service]:
    post:
      summary: (beta) Retrieves product prices
      description: |-
        This operation retrieves the prices for the given product IDs. The request supports up to three additional header and query parameters, where key and value can both be customized.
        
        The minQuantity of a price is only optional if it is 1.
      operationId: getPrices
      parameters:
        - name : tenant-id
          in: header
          description: ID to identify the sender
          schema:
            type: string
            description: ID to identify the sender
          example: inSPIRED
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductPriceRequest'
      responses:
        '200':
          description: OK - The prices have been retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductPriceResponse'
        '401':
          description: Unauthorized - The user could not be authenticated.
        '403':
          description: Forbidden - The user does not have the required permissions.
components:
  schemas:
    ProductPriceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProductPriceRequestData'
    ProductPriceRequestData:
      type: object
      properties:
        customerId:
          type: string
          example: "OilCorp"
          description: The customer for whom the prices are requested. If no customer is given, the value is an empty string.
        tenantId:
          type: string
          example: "inTRONICS"
          description: ID to identify the sender
        priceType:
          type: string
          example: net
          description: The price type used in the channel. The returned prices will be interpreted as prices of this price type.
        priceListType:
          type: string
          example: "SalePrice"
          description: The requested price list type
        currency:
          type: string
          description: Three-letter currency code (ISO 4217) of the monetary value
          example: USD
        products:
          type: array
          items:
            type: string
          example: ["78412-452", "84236-a32"]
          description: A list of product IDs
    ProductPriceResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductPriceContainer'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
    ProductPriceContainer:
      type: object
      required:
        - productId
        - prices
      properties:
        productId:
          type: string
          description: Identifier of a product
          example: "78412-452"
        prices:
          type: array
          items:
            $ref: '#/components/schemas/ScaledPrice'
          description: A list of applicable prices for different quantities of the product
        customAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttribute'
      description: Price container for one product
    ScaledPrice:
      type: object
      properties:
        minQuantity:
          $ref: '#/components/schemas/Quantity'
        singleBasePrice:
          $ref: '#/components/schemas/Money'
      description: A price applicable for a specified minimum order quantity
    CustomAttribute:
      type: object
      properties:
        name:
          type: string
          description: Name of the custom attribute
          example: Tax
        value:
          type: string
          description: Value of the custom attribute
          example: 19
    Message:
      type: object
      properties:
        level:
          type: string
          enum: [INFO, WARN, ERROR]
        code:
          type: string
          example: "product.not_found"
        description:
          type: string
          example: "product with id 84236-a32 not found"
      description: A message to be logged
    Quantity:
      required:
        - value
      type: object
      properties:
        unit:
          type: string
          description: The quantity's unit code
          example: kg
        value:
          type: number
          description: The quantity's value
          example: 10
      description: A quantity of a business entity
    Money:
      required:
        - currency
        - value
      type: object
      properties:
        currency:
          type: string
          description: Three-letter currency code (ISO 4217) of the monetary value
          example: USD
        value:
          type: number
          description: The monetary value
          example: 10.99
      description: Describes a money object