shipping_methods__v2.yml

openapi: 3.0.0
info:
  version: '2'
  title: ShippingMethods
  description: 'Service howtobuy. The service provides methods for obtaining possible delivery methods according to the specified parameters'
externalDocs:
  url: https://github.com/rollun-com/service-howtobay
servers:
  - url: http://carriers/openapi/ShippingMethods/v2
  - url: https://rollun.net/api/openapi/ShippingMethods/v2
tags:
  - name: Shipping
    description: 'Everything about shipping methods.'
paths:
  /shipping:
    post:
      tags:
        - Shipping
      summary: 'Getting Shipping Methods'
      description: 'Returns possible shipping methods with prices, sender, and delivery time.'
      operationId: getShippingMethods
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingWayPostRequest'
      responses:
        "200":
          description: "Order successfully created"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingMethodsResult'
        "500":
          description: 'Some internal error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
components:
  schemas:
    CatalogResponse:
      type: object
      properties:
        zipTo:
          type: string
          example: "78228"
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProductPack'
    ProductPack:
      type: object
      required:
        - weight
        - width
        - length
        - height
        - quantity
      properties:
        weight:
          type: number
          example: 1.0
        width:
          type: number
          example: 2.0
        length:
          type: number
          example: 3.5
        height:
          type: number
          example: 4.0
        quantity:
          type: integer
          example: 2
        attributes:
          type: object
          properties:
            isDangerous:
              description: 'Whether the package contains hazardous materials. It is necessary to determine the possibility of sending by air.'
              type: boolean
              example: false
            isTire:
              description: 'Is it a tire?'
              type: boolean
              example: false
            rid:
              type: string
              example: "1118V"
            auFlatRateGroup:
              type: string
              example: "ATV TIRE/WHEEL"
            rmFlatRateGroup:
              type: string
              example: "ATV TIRE/WHEEL"
            puFlatRateGroup:
              type: string
              example: "ATV TIRE/WHEEL"
            wpsFlatRateGroup:
              type: string
              example: "ATV TIRE/WHEEL"
            wpsCategory:
              type: string
              example: "Wheels"
              description: Enum Tubes, Tires, Wheels
            wpsDropShipFee:
              type: string
              example: "FR"
              description: Ship. price
              nullable: true
    ErrorResult:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: "#/components/schemas/Message"
    SuccessResult:
      allOf:
        - $ref: '#/components/schemas/ErrorResult'
      type: object
      properties:
        data:
          type: object
    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"
    ShippingWayPostRequest:
      type: object
      required:
        - senders
        - customer
        - items
      properties:
        senders:
          type: array
          description: Filter by sender
          items:
            type: string
            example: [tft_ds_a, tft_ds_b, tft_ds_c, tft_ds_d, tft_ds_e, au_ds_a, pu_ds_a, pu_ds_b, pu_ds_c, pu_ds_d, pu_ds_e, rm_ds_a, rm_ds_b, rm_ds_c, rm_ds_d, rm_ds_e, wps_ds_a, wps_ds_b, wps_ds_c, wps_ds_d, wps_ds_e, pickup_ky, pickup_cn, pickup_ut]
        customer:
          $ref: '#/components/schemas/Customer'
        items:
          type: array
          description: List of ordered products
          items:
            $ref: '#/components/schemas/RequestedItem'
        startDateTime:
          type: string
          default: now in UTC
          example: 2024-03-22T12:21:37
        labels:
          type: object
          required:
            - marketplaceName
            - items
            - orderId
          properties:
            marketplaceName:
              type: string
              example: Amazon Shoptimistic
              enum:
                - Amazon Shoptimistic
                - Ebay Plaisir
                - Ebay Rollun
            orderId:
              type: string
              example: 111-8958324-4542656
            items:
              type: array
              items:
                $ref: '#/components/schemas/LineItems'
    LineItems:
      type: object
      properties:
        OrderItemId:
          type: string
          example: 97757136216121
        Quantity:
          type: number
          example: 2
    RequestedItem:
      type: object
      properties:
        rid:
          type: string
          description: item rid
          example: 1SRPW
        qty:
          type: integer
          description: requested qty for item
          example: 2
    ShippingMethodsResponse:
      type: object
      required:
        - sender
        - cost
        - carrier
        - shippingMethodId
        - shippingMethodName
        - trackNumberDate
        - shippingArriveDate
      properties:
        sender:
          type: string
          example: 'wps_ds'
        carrier:
          type: string
          enum:
            - USPS
            - FEDEX
            - UPS
            - TFT
          example: FEDEX
          nullable: true
        shippingMethodId:
          type: string
          example: 'ROF-CN-PickUp-Usps-PM-FR-LegalEnv'
          description:  >
            `ROF` - Rollun Office
            `CN` - state Connecticut
            `PickUp` - Shipping type PickUp
            `Usps-PM-FR-LegalEn` - Shipping Method Usps Priority Mail Legal Flat Rate Envelope
        shippingMethodName:
          type: string
          example: 'Priority Mail Large Flat Rate Board Game Box'
        cost:
          type: number
          example: 5.84
          nullable: true
        trackNumberDate:
          type: string
          description: In UTC
          example: '30.01.2020 16:00:00'
        shippingArriveDate:
          type: string
          description: In UTC
          example: '03.02.2020 3:59:00'
        labelProvider:
          $ref: '#/components/schemas/labelProvider'
      xml:
        name: Shipping
    labelProvider:
      type: object
      required:
        - marketplaceName
        - shippingMethod
        - labelPrice
      properties:
        marketplaceName:
          type: string
          example: Amazon Shoptimistic
        shippingMethod:
          type: string
          example: UPS Ground
        labelPrice:
          type: number
          example: 14.0
    ShippingMethods:
      type: array
      description: 'Found delivery methods'
      items:
        $ref: '#/components/schemas/ShippingMethodsResponse'
    ShippingMethodsResult:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ShippingMethods'
      xml:
        name: GetShippingBody
    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
            - TOO_LARGE
            - CANNOT_FIT
          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