Logistech XML Spec: Procedures: Reports.

XML Procedures:

Call Us 877-430-7448
or contact us
Request More Info

The following URL will allow you to run various reports

https://api.logistech.us/lomacs/xml/report?client=client_code&report=report_type

where the following values are included :

Variable	Description
client_code	Your Logistech client code
report_type	Report type (see individual report)

Individual reports may require extra variables. The reports are returned in an XML document. The root element is the same as report_type. The content of the returned document will vary according to report type.

Product Activity Summary Report

The report type for the Product Activity Summary is "prodactivity". This report requires from_date and to_date variables. The following URL will run the shipment summary report :

https://api.logistech.us/lomacs/xml/report?client=client_code&report=prodactivity& from_date=from_date&to_date=to_date&product=productIds

Variable	Description
client_code	Your Logistech client code
from_date	Starting date for the report
to_date	Ending date for the report
product	Optional, list of products, seperated by commas

If variable product is not specified, all active products are returned.

The product activity summary returns some header information (from_date and to_date) and several product elements containing the following fields :

Element	Description
product_id	LOMACS product Id
description	LOMACS product title
begin_quantity	Inventory as of the beginning of the from_date
received_quantity	quantity of products received within the date range
shipped_quantity	quantity of products shipped within the date range
depleted_quantity	quantity of products removed within the date range; such as inventory corrections or removal of defective product
balance_quantity	quantity of products at the end of the to_date

Example Product Activity Summary Report

The following example shows a product activity summary report :

URL: https://api.logistech.us/lomacs/xml/report?client=1234&report=prodactivity &07%2F01%2F2015&to=07%2F01%2F2015&product=ABC123,EFG456

Returns:

  <?xml version="1.0"?>
  <prodactivity>
   <from_date>07/01/2015</from_date>
   <to_date>07/01/2015</to_date>
   <product>
    <product_id>ABC123</product_id>
    <description>Sample ABC Product</description>
    <begin_quantity>53</begin_quantity>
    <received_quantity>100</received_quantity>
    <shipped_quantity>26</shipped_quantity>
    <depleted_quantity>0</depleted_quantity>
    <balance_quantity>127</balance_quantity>
   </product>
   <product>
    <product_id>EFG456</product_id>
    <description>Sample EFG Product</description>
    <begin_quantity>0</begin_quantity>
    <received_quantity>75</received_quantity>
    <shipped_quantity>6</shipped_quantity>
    <depleted_quantity>2</depleted_quantity>
    <balance_quantity>67</balance_quantity>
   </product>
  </prodactivity>

Product Receipt Detail Report

The report type for the Product Receipt Detail is "prodrec". This report requires from_date and to_date variables.

There are two types of receipts, inbound shipments and adjustments. Dependent on variable setting, the report will return only inbound shipments, only adjustment receipts or both inbound shipments and adjustments. The following URL will run the product receipt detail report :

https://api.logistech.us/lomacs/xml/report?client=client_code&report=prodrec&include=all& from_date=from_date&to_date=to_date&product=productIds

Variable	Description
client_code	Your Logistech client code
from_date	Starting date for the report
to_date	Ending date for the report
include	Optional, if "inbound", only inbound shipments will be report, if "adjrec", only adjustment receipts will be reports, if "all" will report both inbound shipments and adjustment receipts. Default is "all", if no value is set.
product	Optional, list of products, seperated by commas

If variable product is not specified, all active products are returned.

The Product Receipt Details may return the following elements for inbound shipments (inbound):

Element	Description
inbound_id	LOMACS inbound shipment id
inbound_type	ASN - Advanced Shipment Notice NONASN - inbound shipment created as product is received RMA - Return Authroization DSMRA - DropShip RMA - original outbound shipment not shipped by Logistech NONRMA - Returned outbound shipment where RMA does not exists. Examples - carrier returns because of bad address or refusal.
reference1	For RMAs - reference will be original order #, for other inbound type field is optional reference
reference2	2nd optional reference
from_company	Company shipping product in
from_addr1	address of inbound shipper
from_addr2	address of inbound shipper
from_city	city of inbound shipper
from_state	state/province of inbound shipper
from_zip_code	zip/postal code of inbound shipper
from_cntry_code	2 character ISO country code

The Product Receipt Details may return the following elements for adjustment receipts (ticket):

ticket_no	LOMACS internal transaction number, may help to reference if questions arise.
product_id	LOMACS product Id
description	LOMACS product title
added_quantity	quantity product inventory was increase
note	info about why the adjustment was made

Example Product Receipt Detail Report

The following example shows a Product Receipt Detail report :

URL: https://api.logistech.us/lomacs/xml/report?client=1234&report=prodrec &from=07%2F01%2F2015&to=07%2F01%2F2015&

Returns:

  <?xml version="1.0"?>
  <prodrec>
   <from_date>07/01/2015</from_date>
   <to_date>07/01/2015</to_date>
   <inbound_cnt>2</inbound_cnt>
   <inbound>
    <inbound_id>IB-1506012345</inbound_id>
    <inbound_type>RMA</inbound_type>
    <reference1>15-062369999</reference1>  
    <reference2>PO 123532</reference2>
    <from_company>ABC Toys</from_company>
    <from_addr1>2015 BoardWalk Blvd</from_addr1>
    <from_addr2></from_addr2>
    <from_city>Monopoly</from_city>
    <from_state>DC</from_state>
    <from_zip_code>12345</zip_code>
    <from_cntry_code>US</from_cntry_code>
    <product>
     <product_id>CHANCE01</product_id>
     <description>Go Directly to Jail cards</description>
     <received_qty>10</received_qty>
    </product>
   </inbound>
   <inbound>
    <inbound_id>IB-1507012345</inbound_id>
    <inbound_type>ASN</inbound_type>
    <reference1>PO 332341</reference1>  
    <reference2></reference2>
    <from_company>XYZ Widgets</from_company>
    <from_addr1>1234 Main St</from_addr1>
    <from_addr2>Apt 23423431</from_addr2>
    <from_city>Springfield</from_city>
    <from_state>KY</from_state>
    <from_zip_code>52341</zip_code>
    <from_cntry_code>US</from_cntry_code>
    <product>
     <product_id>899439953</product_id>
     <description>Green and Red Medium Blocks<description>
     <received_qty>100</received_qty>
    </product>
    <product>
     <product_id>899435237</product_id>
     <description>Red and Green Small Blocks<description>
     <received_qty>250</received_qty>
    </product>
   </inbound>
   <adjrec>
    <adjrec_cnt>1</adjrec_cnt>
    <ticket>
     <ticket_no>835699</ticket_no>
     <product_id>TRAIN-PA</product_id>
     <description>PA Box Car</description>
     <added_qty>1</added_qty>
     <note>Inventory Audit - found missing box car</note>
    </ticket>
   </adjrec>
  </prodrec>

Product Depletion Detail Report

The report type for the Product Depletion Detail is "proddep". This report requires from_date and to_date variables.

Depletions are deductions of inventory for reasons other than orders; such as, correction after inventory audits, damage product and deffective products. The notes field will give a summary of the reason.

The following URL will run the product depletion detail report :

https://api.logistech.us/lomacs/xml/report?client=client_code&report=proddep& from_date=from_date&to_date=to_date&product=productIds

Variable	Description
client_code	Your Logistech client code
from_date	Starting date for the report
to_date	Ending date for the report
product	Optional, list of products, seperated by commas

If variable product is not specified, depletions for all active products are returned.

The Product Depletion Detail Report may return the following elements for depletions (ticket):

ticket_no	LOMACS internal transaction number, may help to reference if questions arise.
product_id	LOMACS product Id
description	LOMACS product title
reduced_quantity	quantity product inventory was reduced
note	info about why the adjustment was made

Example Product Depletion Detail Report

The following example shows a Product Depletion Detail report :

URL: https://api.logistech.us/lomacs/xml/report?client=1234&report=proddep&from=07%2F01%2F2015&to=07%2F01%2F2015&

Returns:

 <?xml version="1.0"?>
 <proddep>
  <from_date>07/01/2015</from_date>
  <to_date>07/01/2015</to_date>
  <adjdep>2</adjrec_cnt>
  <ticket>
   <ticket_no>8405976</ticket_no>
   <product_id>123401231</product_id>
   <description>XYZ Widget</description>
   <reduced_qty>1</reduced_qty>
   <note>Inventory Audit - correcting inventory</note>
  </ticket>
  <ticket>
   <ticket_no>8405979</ticket_no>
   <product_id>98764247</product_id>
   <description>ABC Widget</description>
   <reduced_qty>2</reduced_qty>
   <note>2 pc found damaged - moving to quarantine</note>
  </ticket>
 </proddep>

Product Shipped Detail Report

The report type for the Product Shipped Detail is "prodshipped". This report requires from_date and to_date variables.

Report returns info of products shipped within the specified date range.

The following URL will run the Product Shipped Detail Report :

https://api.logistech.us/lomacs/xml/report?client=client_code&report=prodshipped&from_date=from_date&to_date=to_date&product=productIds

Variable	Description
client_code	Your Logistech client code
from_date	Starting date for the report
to_date	Ending date for the report
product	Optional, list of products, seperated by commas

If variable product is not specified, reports shipping for all active products.

Example Product Shipped Detail Report

The following example shows a Product Shipped Detail report :

URL: https://api.logistech.us/lomacs/xml/report?client=1234&report=prodshipped&from=07%2F22%2F2015amp;to=07%2F22%2F2015&

Returns:

 <?xml version="1.0"?>
 <prodshiped>
  <from_date>07/22/2015</from_date>
  <to_date>07/22/2015</to_date>
  <prodshipped_cnt>2</prodshipped_cnt> 
  <order>
   <order_id>15-072212345</order_id>
   <reference>8076489</reference>
   <purchase_order>EWV23462</purchase_order>
   <other_ref1>Must Delivery by 8/1/15</other_ref1>
   <other_ref2></other_ref2>
   <to_name>Receiving</to_name>
   <to_company>LMH Industry</to_company>
   <to_addr1>4723 Warehouse Way</to_addr1>
   <to_addr2>Dock # 32</to_addr2>
   <to_city>Kent</to_city>
   <to_state>OH</to_state>
   <to_zip>44240</to_zip>
   <to_cntry_code>US</to_cntry_code>
   <to_email>rec@lmhwarehouse.com</to_email>
   <ship_method>LTL</ship_method>
   <ship_date>07/22/2015</ship_date>
   <product>
    <product_id>28303942</product_id>
    <description>Pallets of Bottled Water</description>
    <shipped_qty>2</shipped_qty>
   </product>
  </order>
  <order>
   <order_id>15-072212349</order_id>
   <reference>234123A</reference>
   <purchase_order>QT234132</purchase_order>
   <other_ref1></other_ref1>
   <other_ref2></other_ref2>
   <to_name>James Miller</to_name>
   <to_company></to_company>
   <to_addr1>1234 North South Blvd</to_addr1>
   <to_addr2></to_addr2>
   <to_city>Trinity</to_city>
   <to_state>NC</to_state>
   <to_zip>27370</to_zip>
   <to_cntry_code>US</to_cntry_code>
   <to_email>jammiller@hotmail.com</to_email>
   <ship_method>US Postal Service</ship_method>
   <ship_date>07/22/2015</ship_date>
   <product>
    <product_id>63454353</product_id>
    <description>Blue test light</description>
    <shipped_qty>4</shipped_qty>
   </product>
   <product>
    <product_id>34242356</product_id>
    <description>Green Test Light</description>
    <shipped_qty>5</shipped_qty>
   </product>
  </order>
  </prodshipped>

Shipment Summary Report

The report type for the shipment summary is "shipsum". This report requires from_date and to_date variables. The following URL will run the shipment summary report :

https://api.logistech.us/lomacs/xml/report?client=client_code&report=shipsum&from_date=from_date&to_date=to_date

Variable	Description
client_code	Your Logistech client code
from_date	Starting date for the report
to_date	Ending date for the report

The shipment summary report returns some header information (from_date and to_date) and several row elements containing the following fields :

Element	Description
rush	Whether or not this was a rush order - "YES" or "NO"
cust_ref_id	The customer reference # for the order (if any)
order_id	The Logistech order ID
ship_no	The shipment number
ship_date	The ship date in MM/DD/YYYY format
ship_method	The carrier that this shipment was shipped by
pieces	The number of pieces in this shipment
items	The number of items in this shipment
shipping_charges	The shipping charges
processing_charges	The processing charges

Example Shipment Summary Report

The following example shows a shipment summary report :

URL: https://api.logistech.us/lomacs/xml/report?client=1234&report=shipsum&from=6%2F01%2F01&to=7%2F01%2F01

Returns:

  <?xml version="1.0"?>
  <shipsum>
   <from_date>06/01/2001</from_date>
   <to_date>07/01/2001</to_date>
   <row>
    <rush>NO</rush>
    <order_id>01-01082080</order_id>
    <ship_no>33534</ship_no>
    <ship_date>06/18/2001</ship_date>
    <ship_method>Customer Pickup</ship_method>
    <pieces>12</pieces>
    <items>1</items>
    <shipping_charges>0</shipping_charges>
    <processing_charges>2.4</processing_charges>
   </row>
   <row>
    <rush>NO</rush>
    <order_id>01-02152341</order_id>
    <ship_no>34072</ship_no>
    <ship_date>06/12/2001</ship_date>
    <ship_method>FedEx Plus</ship_method>
    <pieces>3</pieces>
    <items>1</items>
    <shipping_charges>45</shipping_charges>
    <processing_charges>1.95</processing_charges>
   </row>
  </shipsum>

Inventory Report

The "inventory" report will list all products which are in inventory. The report defaults to showing only active products, but the optional "active" variable can constrain it to show inactive products only, active product only, or both. The following URL will run the inventory report :

https://api.logistech.us/lomacs/xml/report?client=client_code&report=inventory&active=active

Variable	Description
client_code	Your Logistech client code
active	A for active, I for inactive, B for both

The inventory report returns a list of products formatted using the inventory schema. The list is enclosed in an "inventory" element.

Example Inventory Report

The following example shows a shipment summary report :

URL: https://api.logistech.us/lomacs/xml/report?client=1234&report=inventory&active=I

Returns:

  <?xml version="1.0"?>
  <inventory>
   <product>
    <product_id>xyz-test-inactive-1</product_id>
    <description>Test ordering inactive product</description>
     <quantity>
     <in_stock>0</in_stock>
     <on_order>0</on_order>
     </quantity>
   </product>
   <product>
    <product_id>xyz-test-inactive-2</product_id>
    <description>Test ordering inactive products</description>
     <quantity>
     <in_stock>0</in_stock>
     <on_order>0</on_order>
     </quantity>
   </product>
  </inventory>