openapi.yaml

openapi: 3.0.1
info:
  title: Icreated WebStore API
  description: Icreated WebStore for ERP Idempiere
  license:
    name: Apache
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '3.0'
servers:
  - url: http://localhost:3000
    description: Json Server
  - url: http://localhost:8080/services/api
    description: WebStore API
security:
  - bearerAuth: []
paths:
  /account/orders:
    get:
      tags:
        - Account
      summary: Order list
      description: Get customer orders
      operationId: getOrders
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Document'
    post:
      tags:
        - Account
      summary: Order Creation
      description: Create order
      operationId: createOrder
      requestBody:
        description: Order Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'
        required: true
      responses:
        '200':
          description: Order created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '500':
          description: Missing address or shipper or lines
  /account/orders/{id}:
    get:
      tags:
        - Account
      summary: Order information
      description: Get order by ID
      operationId: getOrder
      parameters:
        - name: id
          in: path
          description: C_Order_ID
          required: true
          schema:
            type: integer
            format: int32
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
    delete:
      tags:
        - Account
      summary: Void order
      description: Void order
      operationId: voidOrder
      parameters:
        - name: id
          in: path
          description: C_Order_ID
          required: true
          schema:
            type: integer
            format: int32
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
  /account/orders/{id}/payment:
    post:
      tags:
        - Account
      summary: Payment Creation
      description: Create simple payment
      operationId: payment
      parameters:
        - name: id
          in: path
          description: C_Order_ID
          required: true
          schema:
            type: integer
            format: int32
      requestBody:
        description: Payment Param
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentParam'
        required: true
      responses:
        '200':
          description: Order processed
        '403':
          description: Order forbidden
        '500':
          description: Order not processed
  /account:
    post:
      tags:
        - Account
      summary: Account Creation
      description: Create new account
      operationId: signup
      requestBody:
        description: New Account Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewAccountForm'
        required: true
      responses:
        '200':
          description: Account created, Token in return
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        '400':
          description: Missing Account Info or Email

  /account/addresses:
    get:
      tags:
        - Account
      summary: Address List
      description: Get address list
      operationId: getAddresses
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Address'
    post:
      tags:
        - Account
      summary: Create address info
      description: Create address info
      operationId: createAddress
      requestBody:
        description: Address Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
        required: true
      responses:
        '200':
          description: Address created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
  /account/addresses/{id}:
    parameters:
      - name: id
        in: path
        description: C_BPartner_Location_ID
        required: true
        schema:
          type: integer
          format: int32
    get:
      tags:
        - Account
      summary: Get Address
      description: Get address
      operationId: getAddress
      responses:
        '200':
          description: Address found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
    put:
      tags:
        - Account
      summary: Update address info
      description: Updating address info
      operationId: updateAddress
      requestBody:
        description: Address Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
        required: true
      responses:
        '200':
          description: Address updated
    delete:
      tags:
        - Account
      summary: Deactivating address
      description: Deactivating address
      operationId: deleteAddress
      responses:
        '200':
          description: Address deactivated
  /account/password:
    put:
      tags:
        - Account
      summary: Password change
      description: Change customer password
      operationId: changePassword
      requestBody:
        description: Password Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Password'
        required: true
      responses:
        '200':
          description: Password updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        '202':
          description: Old password not correct
        '500':
          description: Password not changed

  /account/pdf/{type}/{id}:
    get:
      tags:
        - Account
      summary: Order Invoice PDF
      description: Get PDF File
      operationId: downloadDocument
      parameters:
        - name: type
          in: path
          description: Choice between 'order', 'invoice'
          required: true
          schema:
            type: string
            enum:
              - order
              - invoice
        - name: id
          in: path
          description: C_Order_ID or C_Invoice_ID depending from type
          required: true
          schema:
            type: integer
            format: int32
      responses:
        default:
          description: default response
          content:
            application/pdf:
              schema:
                type: string
                format: binary

  /account/info:
    get:
      tags:
        - Account
      summary: Account Info
      description: get account information like name, email
      operationId: getInfo
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInfo'
    put:
      tags:
        - Account
      summary: Update Account Info
      description: Update account info like name, email
      operationId: updateAccount
      requestBody:
        description: Account Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountInfo'
        required: true
      responses:
        '200':
          description: Account updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
  /auth/login:
    post:
      tags:
        - Authentication
      summary: Login
      description: Login
      operationId: authenticateUser
      requestBody:
        description: Login Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCredentials'
        required: true
      responses:
        '200':
          description: JWT Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        '401':
          description: Unauthorized
  /catalog/cart:
    get:
      tags:
        - Catalog
      summary: Cart Product list
      description: Product List from id product list
      operationId: getCart
      parameters:
        - name: ids
          in: query
          description: Product ids
          required: true
          schema:
            type: array
            items:
              type: integer
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PriceListProduct'
  /catalog/products/{categoryId}:
    get:
      tags:
        - Catalog
      summary: Category Products
      description: Product Categories, active, not discontinued & not BOM
      operationId: getProducts
      parameters:
        - name: categoryId
          in: path
          description: Product Category ID
          required: true
          schema:
            type: integer
            format: int32
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PriceListProduct'
  /catalog/categories:
    get:
      tags:
        - Catalog
      summary: Product Category List
      description: Product Categories, active, not discontinued & not BOM
      operationId: getCategories
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProductCategory'
  /catalog/products/featured:
    get:
      tags:
        - Catalog
      summary: Featured products
      description: Featured products - IsWebstoreFeatured = 'Y'
      operationId: getProductsFeatured
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PriceListProduct'
  /catalog/products/search:
    get:
      tags:
        - Catalog
      summary: Search products
      description: Searching products by Name or Description
      operationId: getProductsSearch
      parameters:
        - name: searchString
          in: query
          description: Searching string
          required: true
          schema:
            type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PriceListProduct'
  /common/countries:
    get:
      tags:
        - Common
      summary: Country List
      description: List of all countries
      operationId: getCountries
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdNamePair'
  /common/lookup/email:
    post:
      tags:
        - Common
      summary: Email lookup
      description: Lookup Email
      operationId: lookupEmail
      requestBody:
        description: Token Form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Token'
        required: true
      responses:
        '200':
          description: Email found
          content:
            application/text:
                schema:
                    type: boolean
  /common/shippers:
    get:
      tags:
        - Common
      summary: Shipper List
      description: List of all shippers
      operationId: getShippers
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Shipper'
components:
  schemas:
    Address:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        phone:
          type: string
        location:
          $ref: '#/components/schemas/Location'
      required:
        - name
        - location
    Location:
      type: object
      properties:
        id:
          type: integer
          format: int32
        address1:
          type: string
        address2:
          type: string
        postal:
          type: string
        city:
          type: string
        country:
          $ref: '#/components/schemas/Country'
      required:
        - address1
        - postal
        - city
        - country
    Country:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    Document:
      type: object
      properties:
        id:
          type: integer
          format: int32
        documentNo:
          type: string
        poReference:
          type: string
        description:
          type: string
        docStatus:
          type: string
        docStatusName:
          type: string
        date:
          type: string
          format: date-time
        totalLines:
          type: number
        grandTotal:
          type: number

    DocumentLine:
      type: object
      properties:
        id:
          type: integer
          format: int32
        productId:
          type: integer
          format: int32
        line:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        priceList:
          type: number
        price:
          type: number
        qty:
          type: number
        lineNetAmt:
          type: number
    NewAccountForm:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        password:
          type: string
        confirmPassword:
          type: string
    Password:
      type: object
      properties:
        password:
          type: string
        newPassword:
          type: string
        confirmPassword:
          type: string
    AccountInfo:
      type: object
      properties:
        id:
          type: integer
          format: int32
        value:
          type: string
        name:
          type: string
        email:
          type: string
        birthday:
          type: string
          format: date-time
    Order:
      type: object
      properties:
        id:
          type: integer
          format: int32
        documentNo:
          type: string
        poReference:
          type: string
        description:
          type: string
        docStatus:
          type: string
        docStatusName:
          type: string
        date:
          type: string
          format: date-time
        totalLines:
          type: number
        grandTotal:
          type: number
        lines:
          type: array
          items:
            $ref: '#/components/schemas/DocumentLine'
        shipAddress:
          $ref: '#/components/schemas/Address'
        billAddress:
          $ref: '#/components/schemas/Address'
        shipper:
          $ref: '#/components/schemas/Shipper'
        shipments:
          type: array
          items:
            $ref: '#/components/schemas/Shipment'
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/Document'
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/Tax'
      required:
        - id
    Payment:
      type: object
      properties:
        id:
          type: integer
          format: int32
        documentNo:
          type: string
        description:
          type: string
        docStatus:
          type: string
        payAmt:
          type: number
        trxid:
          type: string
        currency:
          type: string
        tenderType:
          type: string
    Shipment:
      type: object
      properties:
        id:
          type: integer
          format: int32
        documentNo:
          type: string
        description:
          type: string
        docStatus:
          type: string
        docStatusName:
          type: string
        date:
          type: string
          format: date-time
        lines:
          type: array
          items:
            $ref: '#/components/schemas/DocumentLine'
        trackingNo:
          type: string
    Shipper:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    Tax:
      type: object
      properties:
        name:
          type: string
        taxAmt:
          type: number
    UserCredentials:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
    PriceListProduct:
      type: object
      properties:
        id:
          type: integer
          format: int32
        value:
          type: string
        name:
          type: string
        description:
          type: string
        help:
          type: string
        documentNote:
          type: string
        imageURL:
          type: string
        price:
          type: number
        qty:
          type: integer
          format: int32
        line:
          type: integer
          format: int32
      required:
        - id
        - name
        - price
        - qty
        - line
    ProductCategory:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
    PaymentParam:
      type: object
      properties:
        type:
          type: string
          enum:
            - check
            - deposit
    IdNamePair:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    Token:
      type: object
      properties:
        token:
          type: string
        msg:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT