RPC API

StoreKeeper uses HATEOAS RCP API for communicate server and client side each other. The URLs are prefixed with name of application what you can customize in server/config.yml.

Example URL:

http://localhost:8000/<name>/api/<command>

Endpoints

• Acquisitions
  • Data management
    • /api/acquisitions
    • /api/acquisitions/<id>
    • /api/acquisitions/<id>/items
    • /api/acquisitions/<id>/items/<item_id>
• Barcodes
  • Data management
    • /api/barcodes
• Config
  • Getting config values
    • /api/config
• Customers
  • Data management
    • /api/customers
    • /api/customers/<id>
• Error
  • Push error messages
    • /api/error
• Items
  • Data management
    • /api/items
    • /api/items/search
    • /api/items/<id>
    • /api/items/<id>/barcodes
    • /api/items/<id>/barcodes/<id>
  • Commands
    • /api/items/<id>/barcodes/<id>/print
• Session
  • Session management
    • /api/session
• Stocktakings
  • Data management
    • /api/stocktakings
    • /api/stocktakings/<id>
    • /api/stocktakings/<id>/items
    • /api/stocktakings/<id>/items/<item_id>
  • Commands
    • /api/stocktakings/<id>/close
• Units
  • Data management
    • /api/units
    • /api/units/<id>
• Users
  • Data management
    • /api/users
    • /api/users/<id>
  • Config management
    • /api/users/<id>/config
    • /api/users/<id>/config/<id>
• Vendors
  • Data management
    • /api/vendors
    • /api/vendors/<id>
• Works
  • Data management
    • /api/works
    • /api/works/<id>
    • /api/works/<id>/items
    • /api/works/<id>/items/<item_id>
  • Commands
    • /api/works/<id>/close-outbound
    • /api/works/<id>/close-returned