shipping_way__v2.yml

openapi: 3.0.0
info:
  version: "2"
  title: "ShippingWay"
  description: Manifest for calculating shipping ways by items and zipCode
servers:
  - url: http://suppliers/openapi/ShippingWay/v2
  - url: http://host.docker.internal:8403/openapi/ShippingWay/v2
tags:
  - name: ShippingWay
paths:
  "/shippingWay":
    post:
      tags:
        - ShippingWay
      summary: "Calculate shipping ways"
      description: >
        If items are not available than success response with empty shippingWay 
        array (also empty container, packages and inventories) will returned.
        
        
        If individual shippingWay cannot be returned (for any reason like unkown 
        carrier method or price mismatch) you can still return success response
        but with warning message.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingWayPostRequest'
      responses:
        "200":
          description: "Order successfully created"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingWayResult'
        "500":
          description: 'Some internal error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
components:
  schemas:
    # Basic results components
    ErrorResult:
      type: object
      properties:
        messages:
          type: array
          nullable: true
          items:
            $ref: "#/components/schemas/Message"
      description: "Message field is not required"
    Message:
      type: object
      properties:
        level:
          type: string
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
        type:
          type: string
          enum:
            - UNDEFINED
            - LOGGER_MESSAGE
            - IGNORED_SHIPPING_METHOD
            - NO_ESTIMATES_FOR_SHIPPING_METHOD
          description: >
            You can expose this enum for all your errors
            UNDEFINED - Any undefined message type
            LOGGER_MESSAGE - Same as undefined 
            IGNORED_SHIPPING_METHOD - shipping method was ignored for any reasone (restricted, etc.)
            NO_ESTIMATES_FOR_SHIPPING_METHOD - shipping method was ignored because it is not possible to calculate estimate dates for it
        text:
          type: string
          description: Message, that describes what went wrong
    SuccessResult:
      allOf:
        - $ref: '#/components/schemas/ErrorResult'
      type: object
      properties:
        data:
          nullable: true
          type: object

    ## One resource result
    ShippingWayResult:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
      type: object
      properties:
        data:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/FullShippingWay'

    ## Body for post request
    ShippingWayPostRequest:
      type: object
      properties:
        sender:
          type: string
          nullable: true
          example: au_ds_all
        customer:
          $ref: '#/components/schemas/Customer'
        items:
          type: array
          description: List of ordered products
          items:
            $ref: '#/components/schemas/RequestedItem'

    RequestedItem:
      type: object
      properties:
        rid:
          type: string
          description: item rid
          example: RID01
        qty:
          type: number
          description: requested qty for item
          example: 1

    ## Resource object
    FullShippingWay:
      type: object
      nullable: true
      properties:
        containers:
          type: array
          items:
            $ref: '#/components/schemas/Container'
        packages:
          type: array
          items:
            $ref: '#/components/schemas/Package'
        inventories:
          type: array
          items:
            $ref: '#/components/schemas/Inventory'
        shippingWays:
          type: array
          items:
            $ref: '#/components/schemas/ShippingWay'

    Container:
      type: object
      properties:
        type:
          type: string
          description: container type
          example: Box

    Package:
      type: object
      properties:
        id:
          type: number
          example: 1
        container:
          type: string
          description: container type
          nullable: true
          example: box
        items:
          type: array
          items:
            $ref: '#/components/schemas/PackageItem'

    PackageItem:
      type: object
      properties:
        csn:
          type: string
          example: CSN01
        rid:
          type: string
          example: RID01
        qty:
          type: number
          example: 1

    Inventory:
      type: object
      properties:
        warehouseName:
          type: string
          example: 'AU_ALL'
        warehouseSpeed:
          type: string
          example: A
        supplier:
          type: string
          example: Autodist
        items:
          type: array
          items:
            $ref: '#/components/schemas/InventoryItem'

    InventoryItem:
      type: object
      properties:
        csn:
          type: string
          example: CSN01
        rid:
          type: string
          example: RID01
        qty:
          type: number
          example: 1
        unitPrice:
          type: number
          example: 20.00

    ShippingWay:
      type: object
      properties:
        package:
          type: number
          example: 1
        sender:
          type: string
          example: AU_DS_A
        carrier:
          type: string
          example: Autodist
        shippingMethod:
          type: string
          example: USPS First class
        fromWarehouses:
          type: array
          items:
            $ref: '#/components/schemas/FromWarehouse'
        shippingDates:
          $ref: '#/components/schemas/ShippingDates'
        itemsTotalPrice:
          type: number
          example: 20.00
        shippingPrice:
          type: number
          example: 5.00
        otherCosts:
          type: number
          example: 0.00
        totalPrice:
          type: number
          example: 25.00

    FromWarehouse:
      type: object
      properties:
        name:
          type: string
          example: AU_ALL
        items:
          type: array
          items:
            $ref: '#/components/schemas/FromWarehouseItem'

    FromWarehouseItem:
      type: object
      properties:
        csn:
          type: string
          example: CSN01
        rid:
          type: string
          example: RID01
        qty:
          type: number
          example: 1

    ShippingDates:
      type: object
      properties:
        estDeliveryDate:
          type: string
          format: date-time
        trackNumberReceiptDate:
          type: string
          format: date-time

    Customer:
      type: object
      required:
        - name
        - address
      properties:
        name:
          type: string
          description: Full name
          example: Shawn Weisweaver
        phone:
          type: string
          nullable: true
          description: Phone number to reach the person
          example: "415-123-4567"
        email:
          type: string
          nullable: true
          description: Email address to reach the person
          example: "test@mail.loc"
        address:
          $ref: "#/components/schemas/Address"
    Address:
      type: object
      required:
        - country
        - state
        - city
        - postalCode
        - address1
      properties:
        country:
          type: string
          description: "Country code"
        state:
          type: string
          description: US state code
          example: CA
        city:
          type: string
          description: Full city name
          example: San Francisco
        postalCode:
          type: string
          description: ZIP or postal code
          example: "94104"
        address1:
          type: string
          description: First line of the address
          example: "417 Montgomery St"
        address2:
          type: string
          nullable: true
          description: Second line of the address
          example: "Floor 5"