Reporting API

Clougistic (csv) reports are available on API or through the Google Looker Reporting connector.  To access reports, a user with API access is needed. Every report is available on a per entity base.

The following reports are available:

Product Metrics

endpoint: product-metrics

api version: 1

Available attributes:
sku
name
brand
category
qty_inventory
qty_available
qty_purchase
qty_check
qty_blocked
qty_reserved
qty_reserved_unassigned
qty_needed
qty_shipped
replenishment_policy
is_mbom
is_kem
supplier_count

Product Mbom

endpoint: product-mbom

api version: 1

Available attributes:
mbom_sku
mbom_name
material_sku
material_name
material_qty

Product Supply

endpoint: product-supply

api version: 1

Available attributes:
supplier_name
sku
gtin
brand
name
currency
unit_price
unit_qty
has_associated_product

Product Replenishment Policies

endpoint: product-replenishment-policies

api version: 1

Available attributes:
sku
name
replenishment_policy
qty_min
qty_max

Cost of Goods Sold v2

endpoint: cost-of-goods-sold

api version: 2

Available attributes:
orderitem_id
sku
description
unit_price
qty
cost
order_item_reference
entity
order_id
order_reference
is_accum
order_type

Cost of Goods Sold v2.1  - all mutations per entity

endpoint: cost-of-goods-sold
mandatory field api call: source_id

optional:

date_from
date_to

api version: 2.1

Available attributes:
id  (order item id)
order_id
order_reference
sku
entity
qty
cost
date  (mutation date)

Cost of Goods Sold v2.2  - MBOM

endpoint: cost-of-goods-sold
mandatory: date_from

optional:

date_to (max 90 days after date_from, if omitted it's 90 days after date_from)
source_id (comma separated list, if omitted all source ids are returned)
order_type (comma separated list, if omitted all order types are returned)

api version: 2.2

Available attributes:
order_id
order_reference
order_type
order_item_id
sku
description
material_order_item_id
material_sku
material_description
entity
qty
cost
cost_qty
date  (last shipment date)

Stock Availability

endpoint: stock-availability

api version: 1

Available attributes:
sku
name
brand
category
qty

Stock Value

endpoint: stock-value

api version: 1

Available attributes:
id
sku
cost
qty
date

Inventory Locations

endpoint: inventory-locations

api version: 1

Available attributes:
sku
zone
path
qty
cost

Inventory Mutations

endpoint: inventory-mutations

api version: 1

Maximum Date Range: Date From + 90 days  and Limited Date Range: Date From -> Date To

Available attributes:
id
sku
qty
brand
category
description
info
entity
source_entity
mutable_type
mutable_id
user_name
date

Cycle Count

endpoint: cycle-count

api version: 1

Available attributes:
sku
product_name
zone_id
path
user_name
qty_counted
date

Sale Orders

endpoint: sale-orders

api version: 1

Maximum Date Range: Date From + 90 days  and Limited Date Range: Date From -> Date To

Available attributes:
id
reference
cod_amount
total_amount
currency
flag_partial
status
contact
shipping_contact
shipping_street
shipping_shipping_housenumber
shipping_housenumber_ext
shipping_postcode
shipping_city
shipping_country
shipping_region
item_qty
item_qty_allocated
item_qty_shipped
item_amount
item_amount_allocated
item_prc_allocated
item_prc_process
item_prc_shipped
date

Shipments

endpoint: shipments

api version: 1

Maximum Date Range: Date From + 90 days  and Limited Date Range: Date From -> Date To

Available attributes:
id
order_id
item_qty
date

Supply Order Items

endpoint: supply-order-items

api version: 1

Maximum Date Range: Date From + 90 days  and Limited Date Range: Date From -> Date To

Available attributes:
purchase_id

purchase_reference

sku

supplier_name

purchase_status

purchase_date

purchase_qty

purchase_unit_qty

purchase_unit_price

purchase_subtotal

reception_date

reception_item_start_date (reception of the item)

reception_id

reception_reference

reception_status

reception_qty

invoice_id

invoice_date

invoice_reference

invoice_status

invoice_currency

invoice_exchange_rate

invoice_qty

invoice_cost

invoice_cost_total

Queued metrics

A change on a metric is queued and available to be pulled. Please check the example of Inventory & Product updates here

Product (summary)

Available attributes:
sku
qty_inventory
qty_available
qty_supply
qty_check

qty_blocked

qty_reserved  (all)

qty_reserved_unassigned (not assigned to a PO)

eta