Package com.sgapi.services

Class IntegrationExportTransactions

  • public class IntegrationExportTransactions
extends java.lang.Object
    Provides more concise transactional data. This collection of endpoints returns simple linear data objects rather than the fully blown objects which you receive with IntegrationExport. This is useful if the client is only interested in small parts of data or data processing/bandwith/processing power is limited.
    Author:
    SG Systems
    Target Uri:
    /integrate/export/transactions

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response getAdjustments()
      Provides a list of adjustment transactions which have occurred
      javax.ws.rs.core.Response getBatching​(boolean completeBatches)
      Provides a list of batch transactions with the option of retrieving transactions for completed batches only.
      javax.ws.rs.core.Response getBatchingFilterFrom​(java.lang.Long filterDate)
      Provides a list of batch transactions with the allocation of a filter parameter
      javax.ws.rs.core.Response getBatchingFilterFromLog​(int logId)
      Provides a list of batch transactions with the allocation of a filter parameter
      javax.ws.rs.core.Response getCommodityTotalPerLot()
      Provides a list of commodities in the system with a sum of total quantity for each, split per lot See CommodityTotalPerLot
      javax.ws.rs.core.Response getCommodityTotalPerLotIncExpired()
      Provides a list of commodities in the system with a sum of total quantity for each, split per lot See CommodityTotalPerLot
      javax.ws.rs.core.Response getCommodityTotals()
      Provides a list of commodities in the system with a sum of total quantity for each See CommodityTotal
      javax.ws.rs.core.Response getContainerLinks()
      See ContainerLinkTransaction
      javax.ws.rs.core.Response getInternalMovements()
      A list of internal stock or pallet movements within the system.
      javax.ws.rs.core.Response getPurchase()
      Provides transactions related to purchase orders in a linear format.
      javax.ws.rs.core.Response getSales​(boolean completeOrders)
      Provides a list of Sales Order transactions with the option of retreiving logs for completed sales orders only.
      javax.ws.rs.core.Response getTransfer()
      Provides transactions related to transfers in a linear format.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IntegrationExportTransactions

        public IntegrationExportTransactions()

    • Method Detail

      • getPurchase

        public javax.ws.rs.core.Response getPurchase()
        Provides transactions related to purchase orders in a linear format.
        Returns:
        purchase order related transactions. See PurchaseTransaction
        Target Uri:
        /purchase
        Request Type:
        GET

      • getBatchingFilterFrom

        public javax.ws.rs.core.Response getBatchingFilterFrom​(java.lang.Long filterDate)
        Provides a list of batch transactions with the allocation of a filter parameter
        Parameters:
        filterDate - The date you wish to filter the data from. This correlates to the timestamp of the logs
        Returns:
        A list of batch transactions such as consumption and production. See BatchTransaction
        Target Uri:
        /batching/filterFrom/{filterDate}
        Request Type:
        GET

      • getBatchingFilterFromLog

        public javax.ws.rs.core.Response getBatchingFilterFromLog​(int logId)
        Provides a list of batch transactions with the allocation of a filter parameter
        Parameters:
        logId - The log ID value to filter the results from
        Returns:
        A list of batch transactions such as consumption and production. See BatchTransaction
        Target Uri:
        /batching/filterFromLog/{logId}
        Request Type:
        GET

      • getBatching

        public javax.ws.rs.core.Response getBatching​(boolean completeBatches)
        Provides a list of batch transactions with the option of retrieving transactions for completed batches only.
        Parameters:
        completeBatches - Whether to retrieve transactions relating to complete batches only.
        Returns:
        A list of batch transactions. See BatchTransaction
        Target Uri:
        /batching/{completeBatches}
        Request Type:
        GET

      • getSales

        public javax.ws.rs.core.Response getSales​(boolean completeOrders)
        Provides a list of Sales Order transactions with the option of retreiving logs for completed sales orders only.
        Parameters:
        completeOrders - Whether to retrieve transactions relating to completed orders only.
        Returns:
        A list of sales order related transactions. See SalesTransaction
        Target Uri:
        /sales/{completeOrders}
        Request Type:
        GET

      • getAdjustments

        public javax.ws.rs.core.Response getAdjustments()
        Provides a list of adjustment transactions which have occurred
        Returns:
        A list of stock adjustment transactions which have not yet been exported. See StockTransaction
        Target Uri:
        /adjustments
        Request Type:
        GET

      • getInternalMovements

        public javax.ws.rs.core.Response getInternalMovements()
        A list of internal stock or pallet movements within the system. These are defined as movements which have not left the site.
        Returns:
        A list of internal stock/pallet transactions. See MovementTransaction
        Target Uri:
        /internal_movements
        Request Type:
        GET

      • getCommodityTotals

        public javax.ws.rs.core.Response getCommodityTotals()
        Provides a list of commodities in the system with a sum of total quantity for each See CommodityTotal
        Returns:
        A list of inventory in the system, grouped by commodity, with inventory totals CommodityTotal
        Target Uri:
        /commodity_totals
        Request Type:
        GET

      • getCommodityTotalPerLot

        public javax.ws.rs.core.Response getCommodityTotalPerLot()
        Provides a list of commodities in the system with a sum of total quantity for each, split per lot See CommodityTotalPerLot
        Returns:
        A list of inventory in the system, grouped by commodity, with inventory totals CommodityTotalPerLot
        Target Uri:
        /commodity_totals_per_lot
        Request Type:
        GET

      • getCommodityTotalPerLotIncExpired

        public javax.ws.rs.core.Response getCommodityTotalPerLotIncExpired()
        Provides a list of commodities in the system with a sum of total quantity for each, split per lot See CommodityTotalPerLot
        Returns:
        A list of inventory in the system, grouped by commodity, with inventory totals CommodityTotalPerLot
        Target Uri:
        /commodity_totals_per_lot/include_expired
        Request Type:
        GET

      • getTransfer

        public javax.ws.rs.core.Response getTransfer()
        Provides transactions related to transfers in a linear format.
        Returns:
        transfer order related transactions. See TransferTransaction
        Target Uri:
        /transfers
        Request Type:
        GET