spec.yaml

swagger: '2.0'
info:
  version: 1.0.0
  title: Logistics Wizard ERP
  description: Defines the minimum set of data models and operations required by the Logistics Wizard application
  license:
    name: Apache 2.0
basePath: /api/v1
consumes:
  - application/json
produces:
  - application/json
paths:
  '/Suppliers/{id}':
    get:
      tags:
        - Supplier
      summary: Find a model instance by id from the data source.
      operationId: Supplier.findById
      parameters:
        - name: id
          in: path
          description: Model id
          required: true
          type: number
        - name: filter
          in: query
          description: Filter defining fields and include
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Supplier'
      deprecated: false
  /Suppliers:
    get:
      tags:
        - Supplier
      summary: Find all instances of the model matched by filter from the data source.
      operationId: Supplier.find
      parameters:
        - name: filter
          in: query
          description: 'Filter defining fields, where, include, order, offset, and limit'
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Supplier'
      deprecated: false
  '/Products/{id}/distributionCenters':
    get:
      tags:
        - Product
      summary: Queries distributionCenters of Product.
      operationId: Product.prototype.__get__distributionCenters
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          format: JSON
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/DistributionCenter'
      deprecated: false
  '/Products/{id}':
    get:
      tags:
        - Product
      summary: Find a model instance by id from the data source.
      operationId: Product.findById
      parameters:
        - name: id
          in: path
          description: Model id
          required: true
          type: number
        - name: filter
          in: query
          description: Filter defining fields and include
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Product'
      deprecated: false
  /Products:
    get:
      tags:
        - Product
      summary: Find all instances of the model matched by filter from the data source.
      operationId: Product.find
      parameters:
        - name: filter
          in: query
          description: 'Filter defining fields, where, include, order, offset, and limit'
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Product'
      deprecated: false
  '/DistributionCenters/{id}/inventories':
    get:
      tags:
        - DistributionCenter
      summary: Gets inventories at the given distribution center.
      operationId: DistributionCenter.getInventories
      parameters:
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Inventory'
      deprecated: false
  '/DistributionCenters/{id}':
    get:
      tags:
        - DistributionCenter
      summary: Find a model instance by id from the data source.
      operationId: DistributionCenter.findById
      parameters:
        - name: id
          in: path
          description: Model id
          required: true
          type: number
        - name: filter
          in: query
          description: Filter defining fields and include
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DistributionCenter'
      deprecated: false
  /DistributionCenters:
    get:
      tags:
        - DistributionCenter
      summary: Find all instances of the model matched by filter from the data source.
      operationId: DistributionCenter.find
      parameters:
        - name: filter
          in: query
          description: 'Filter defining fields, where, include, order, offset, and limit'
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/DistributionCenter'
      deprecated: false
  '/Shipments/{id}/distributionCenter':
    get:
      tags:
        - Shipment
      summary: Fetches belongsTo relation distributionCenter.
      operationId: Shipment.prototype.__get__distributionCenter
      parameters:
        - name: refresh
          in: query
          required: false
          type: boolean
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/DistributionCenter'
      deprecated: false
  '/Shipments/{id}/retailer':
    get:
      tags:
        - Shipment
      summary: Fetches belongsTo relation retailer.
      operationId: Shipment.prototype.__get__retailer
      parameters:
        - name: refresh
          in: query
          required: false
          type: boolean
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Retailer'
      deprecated: false
  '/Shipments/{id}/items':
    get:
      tags:
        - Shipment
      summary: Queries items of Shipment.
      operationId: Shipment.prototype.__get__items
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          format: JSON
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/LineItem'
      deprecated: false
    post:
      tags:
        - Shipment
      summary: Adds new line items to a shipment
      operationId: Shipment.addItems
      parameters:
        - name: id
          in: path
          required: true
          type: number
        - name: data
          in: body
          required: true
          schema:
            type: array
            items:
              $ref: '#/definitions/LineItem'
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/LineItem'
      deprecated: false
  /Shipments:
    post:
      tags:
        - Shipment
      summary: Create a new instance of the model and persist it into the data source.
      operationId: Shipment.create
      parameters:
        - name: data
          in: body
          description: Model instance data
          required: false
          schema:
            $ref: '#/definitions/Shipment'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Shipment'
      deprecated: false
    get:
      tags:
        - Shipment
      summary: Find all instances of the model matched by filter from the data source.
      operationId: Shipment.find
      parameters:
        - name: filter
          in: query
          description: 'Filter defining fields, where, include, order, offset, and limit'
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Shipment'
      deprecated: false
  '/Shipments/{id}':
    get:
      tags:
        - Shipment
      summary: Find a model instance by id from the data source.
      operationId: Shipment.findById
      parameters:
        - name: id
          in: path
          description: Model id
          required: true
          type: number
        - name: filter
          in: query
          description: Filter defining fields and include
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Shipment'
      deprecated: false
    put:
      tags:
        - Shipment
      summary: Updates the status of a shipment as it moves along the supply-chain.
      operationId: Shipment.updateShipmentStatus
      parameters:
        - name: id
          in: path
          required: true
          type: number
        - name: data
          in: body
          description: >-
            The update to apply to the Shipment. Only status,
            estimatedTimeOfArrival and currentLocation can be updated
          required: true
          schema:
            description: >-
              The update to apply to the Shipment. Only status,
              estimatedTimeOfArrival and currentLocation can be updated
            $ref: '#/definitions/Shipment'
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Shipment'
      deprecated: false
    delete:
      tags:
        - Shipment
      summary: Cancels the given shipment.
      operationId: Shipment.cancelShipment
      parameters:
        - name: id
          in: path
          required: true
          type: number
      responses:
        '204':
          description: Request was successful
      deprecated: false
  '/Retailers/{id}/manager':
    get:
      tags:
        - Retailer
      summary: Fetches belongsTo relation manager.
      operationId: Retailer.prototype.__get__manager
      parameters:
        - name: refresh
          in: query
          required: false
          type: boolean
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ERPUser'
      deprecated: false
  '/Retailers/{id}/inventories':
    get:
      tags:
        - Retailer
      summary: Queries inventories of Retailer.
      operationId: Retailer.prototype.__get__inventories
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          format: JSON
        - name: id
          in: path
          description: PersistedModel id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Inventory'
      deprecated: false
  '/Retailers/{id}':
    get:
      tags:
        - Retailer
      summary: Find a model instance by id from the data source.
      operationId: Retailer.findById
      parameters:
        - name: id
          in: path
          description: Model id
          required: true
          type: number
        - name: filter
          in: query
          description: Filter defining fields and include
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Retailer'
      deprecated: false
  /Retailers:
    get:
      tags:
        - Retailer
      summary: Find all instances of the model matched by filter from the data source.
      operationId: Retailer.find
      parameters:
        - name: filter
          in: query
          description: 'Filter defining fields, where, include, order, offset, and limit'
          required: false
          type: string
          format: JSON
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Retailer'
      deprecated: false
  '/Users/{id}/accessTokens/{fk}':
    get:
      tags:
        - ERPUser
      summary: Find a related item by id for accessTokens.
      operationId: ERPUser.prototype.__findById__accessTokens
      parameters:
        - name: fk
          in: path
          description: Foreign key for accessTokens
          required: true
          type: string
          format: JSON
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/AccessToken'
      deprecated: false
    delete:
      tags:
        - ERPUser
      summary: Delete a related item by id for accessTokens.
      operationId: ERPUser.prototype.__destroyById__accessTokens
      parameters:
        - name: fk
          in: path
          description: Foreign key for accessTokens
          required: true
          type: string
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '204':
          description: Request was successful
      deprecated: false
    put:
      tags:
        - ERPUser
      summary: Update a related item by id for accessTokens.
      operationId: ERPUser.prototype.__updateById__accessTokens
      parameters:
        - name: fk
          in: path
          description: Foreign key for accessTokens
          required: true
          type: string
        - name: data
          in: body
          required: false
          schema:
            $ref: '#/definitions/AccessToken'
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/AccessToken'
      deprecated: false
  '/Users/{id}/accessTokens':
    get:
      tags:
        - ERPUser
      summary: Queries accessTokens of ERPUser.
      operationId: ERPUser.prototype.__get__accessTokens
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          format: JSON
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/AccessToken'
      deprecated: false
    post:
      tags:
        - ERPUser
      summary: Creates a new instance in accessTokens of this model.
      operationId: ERPUser.prototype.__create__accessTokens
      parameters:
        - name: data
          in: body
          required: false
          schema:
            $ref: '#/definitions/AccessToken'
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/AccessToken'
      deprecated: false
    delete:
      tags:
        - ERPUser
      summary: Deletes all accessTokens of this model.
      operationId: ERPUser.prototype.__delete__accessTokens
      parameters:
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '204':
          description: Request was successful
      deprecated: false
  '/Users/{id}/accessTokens/count':
    get:
      tags:
        - ERPUser
      summary: Counts accessTokens of ERPUser.
      operationId: ERPUser.prototype.__count__accessTokens
      parameters:
        - name: where
          in: query
          description: Criteria to match model instances
          required: false
          type: string
          format: JSON
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: object
            properties:
              count:
                type: number
                format: double
      deprecated: false
  '/Users/{id}/roles':
    get:
      tags:
        - ERPUser
      summary: Queries roles of ERPUser.
      operationId: ERPUser.prototype.__get__roles
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          format: JSON
        - name: id
          in: path
          description: User id
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Role'
      deprecated: false
  /Users/logout:
    post:
      tags:
        - ERPUser
      summary: Logout a user with access token.
      operationId: ERPUser.logout
      parameters: []
      responses:
        '204':
          description: Request was successful
      deprecated: false
  /Demos:
    post:
      tags:
        - Demo
      summary: Creates a new Demo environment
      operationId: Demo.newDemo
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Demo'
      deprecated: false
  '/Demos/findByGuid/{guid}':
    get:
      tags:
        - Demo
      summary: Retrieves the Demo environment with the given guid
      operationId: Demo.findByGuid
      parameters:
        - name: guid
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/Demo'
      deprecated: false
  '/Demos/{guid}/retailers':
    get:
      tags:
        - Demo
      summary: Returns all retailers
      operationId: Demo.retailers
      parameters:
        - name: guid
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Request was successful
          schema:
            type: array
            items:
              $ref: '#/definitions/Retailer'
      deprecated: false
  '/Demos/{guid}/loginAs':
    post:
      tags:
        - Demo
      summary: Logs in as the specified user belonging to the given demo environment
      operationId: Demo.loginAs
      parameters:
        - name: guid
          in: path
          required: true
          type: string
        - name: userId
          in: formData
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/LoginResponse'
      deprecated: false
  '/Demos/{guid}':
    delete:
      tags:
        - Demo
      summary: Deletes the given demo environment
      operationId: Demo.deleteByGuid
      parameters:
        - name: guid
          in: path
          required: true
          type: string
      responses:
        '204':
          description: Request was successful
      deprecated: false
  '/Demos/{guid}/createUser':
    post:
      tags:
        - Demo
      summary: Adds a new Retail Store manager to the given demo environment
      operationId: Demo.createUserByGuid
      parameters:
        - name: guid
          in: path
          required: true
          type: string
        - name: retailerId
          in: formData
          required: true
          type: number
      responses:
        '200':
          description: Request was successful
          schema:
            $ref: '#/definitions/ERPUser'
      deprecated: false
definitions:
  Supplier:
    properties:
      name:
        type: string
      id:
        type: number
    required:
      - name
    additionalProperties: false
  DistributionCenter:
    properties:
      id:
        type: number
      address:
        $ref: '#/definitions/Address'
      contact:
        $ref: '#/definitions/Contact'
    additionalProperties: false
  Product:
    properties:
      name:
        type: string
      id:
        type: number
      supplierId:
        type: number
    required:
      - name
    additionalProperties: false
  Inventory:
    properties:
      quantity:
        default: 0
        type: number
      id:
        type: number
      productId:
        type: number
      locationId:
        type: number
      locationType:
        type: string
    additionalProperties: false
  Retailer:
    properties:
      id:
        type: number
      address:
        $ref: '#/definitions/Address'
      managerId:
        type: number
    additionalProperties: false
  LineItem:
    properties:
      quantity:
        default: 0
        type: number
      id:
        type: number
      productId:
        type: number
      shipmentId:
        type: number
    required:
      - quantity
      - productId
    additionalProperties: false
  Shipment:
    properties:
      status:
        default: NEW
        type: string
      createdAt:
        type: string
        format: date
      updatedAt:
        type: string
        format: date
      deliveredAt:
        type: string
        format: date
      estimatedTimeOfArrival:
        type: string
        format: date
      fromId:
        type: number
      toId:
        type: number
      id:
        type: number
      currentLocation:
        $ref: '#/definitions/Address'
    required:
      - status
      - createdAt
      - estimatedTimeOfArrival
      - fromId
      - toId
    additionalProperties: false
  ERPUser:
    properties:
      username:
        type: string
      email:
        type: string
      created:
        type: string
        format: date
      id:
        type: number
      demoId:
        type: number
      roles:
        type: array
        items:
          $ref: "#/definitions/Role"
    required:
      - id
      - email
    additionalProperties: false
  AccessToken:
    properties:
      id:
        type: string
      ttl:
        default: 1209600
        description: time to live in seconds (2 weeks by default)
        type: number
        format: double
      created:
        type: string
        format: date
      userId:
        type: number
    required:
      - id
    additionalProperties: false
  Role:
    properties:
      id:
        type: number
      name:
        type: string
      description:
        type: string
      created:
        type: string
        format: date
      modified:
        type: string
        format: date
    required:
      - name
    additionalProperties: false
  Demo:
    properties:
      createdAt:
        type: string
        format: date
      guid:
        type: string
      id:
        type: number
      users:
        type: array
        items:
          $ref: "#/definitions/ERPUser"
    additionalProperties: false
  LoginResponse:
    properties:
      token:
        $ref: '#/definitions/AccessToken'
      user:
        $ref: '#/definitions/ERPUser'
    additionalProperties: false
  Address:
    properties:
      city:
        type: string
      state:
        type: string
      country:
        type: string
      latitude:
        type: number
        format: double
      longitude:
        type: number
        format: double
    additionalProperties: false
  Contact:
    properties:
      name:
        type: string
    required:
      - name
    additionalProperties: false
tags:
  - name: Supplier
  - name: Product
  - name: DistributionCenter
  - name: Shipment
  - name: Retailer
  - name: ERPUser
  - name: Demo