API Reference

Reports

Generate various reports for inventory, consignments, stock, and operations. Reports are available in JSON format and as downloadable Excel (XLSX) files.

Endpoints Overview

Stock Reports

Method Endpoint Description
POST /v1/reports/stock-on-hand Stock on hand report
POST /v1/reports/stock-on-hand/xlsx Stock on hand as Excel
POST /v1/reports/stock-balance Stock balance report
POST /v1/reports/stock-balance/xlsx Stock balance as Excel
POST /v1/reports/stock-age Stock age report
POST /v1/reports/stock-age/xlsx Stock age as Excel
POST /v1/reports/stock-position Stock position report
POST /v1/reports/stock-position/xlsx Stock position as Excel
POST /v1/reports/stock-summary Stock summary report
POST /v1/reports/stock-summary/xlsx Stock summary as Excel

Consignment Reports

Method Endpoint Description
POST /v1/reports/consignment-consumables Consignment consumables summary
POST /v1/reports/consignment-consumables/xlsx Consignment consumables summary as Excel
POST /v1/reports/consignment-metrics Consignment metrics summary
POST /v1/reports/consignment-metrics/xlsx Consignment metrics summary as Excel
POST /v1/reports/consignment-product-detail Consignment product details
POST /v1/reports/consignment-product-detail/xlsx Consignment product details as Excel
POST /v1/reports/consignment-product-dispatched Consignment product dispatched
POST /v1/reports/consignment-product-dispatched/xlsx Consignment product dispatched as Excel
POST /v1/reports/consignment-product-due Consignment product due in
POST /v1/reports/consignment-product-due/xlsx Consignment product due in as Excel
POST /v1/reports/consignment-product-received Consignment product received
POST /v1/reports/consignment-product-received/xlsx Consignment product received as Excel
POST /v1/reports/consignment-tasks Consignment tasks summary
POST /v1/reports/consignment-tasks/xlsx Consignment tasks summary as Excel
POST /v1/reports/inward-consignment-summary Inward consignment summary
POST /v1/reports/inward-consignment-summary/xlsx Inward summary as Excel
POST /v1/reports/outward-consignment-summary Outward consignment summary
POST /v1/reports/outward-consignment-summary/xlsx Outward summary as Excel

Operations Reports

Method Endpoint Description
POST /v1/reports/carrier-charges Carrier charges (freight incurred) report
POST /v1/reports/carrier-charges/xlsx Carrier charges (freight incurred) report as Excel
POST /v1/reports/client-charges Client charges (freight charged) report
POST /v1/reports/client-charges/xlsx Client charges (freight charged) report as Excel
POST /v1/reports/cycle-count Cycle count report
POST /v1/reports/cycle-count/xlsx Cycle count report as Excel
POST /v1/reports/freight-margin Freight margin report
POST /v1/reports/freight-margin/xlsx Freight margin report as Excel
POST /v1/reports/location-status Location status report
POST /v1/reports/location-status/xlsx Location status as Excel
POST /v1/reports/pickface-exception Pickface exception report
POST /v1/reports/pickface-exception/xlsx Pickface exception as Excel
POST /v1/reports/pickface-replenishment Pickface replenishment report
POST /v1/reports/pickface-replenishment/xlsx Pickface replenishment as Excel
POST /v1/reports/product-transaction-detail Product transaction detail
POST /v1/reports/product-transaction-detail/xlsx Product transactions as Excel
POST /v1/reports/scheduled-transactions Scheduled transactions report
POST /v1/reports/scheduled-transactions/xlsx Scheduled transactions as Excel
POST /v1/reports/schedule-summary Schedule summary report
POST /v1/reports/schedule-summary/xlsx Schedule summary as Excel

Stock On Hand Report

Get current stock on hand with optional filters.

Endpoint: POST /v1/reports/stock-on-hand

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "partnerId": "550e8400-e29b-41d4-a716-446655446001",
  "partnerProductId": null,
  "includeZeroQuantity": false
}
Field Type Required Description
warehouseId uuid No Filter by warehouse
partnerId uuid No Filter by partner
partnerProductId uuid No Filter by product
includeZeroQuantity boolean No Include zero stock items

Request Example 

curl -X POST "https://api.consignlyhq.com/v1/reports/stock-on-hand" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
    "includeZeroQuantity": false
  }'

Response Example 

[
  {
    "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
    "warehouseName": "Main Warehouse",
    "partnerId": "550e8400-e29b-41d4-a716-446655446001",
    "partnerName": "Example Client",
    "partnerProductId": "550e8400-e29b-41d4-a716-446655446010",
    "partnerProductCode": "PROD-A",
    "partnerProductName": "Product A",
    "batch": "BATCH-001",
    "expiryDate": "2025-12-31",
    "onHandQuantity": 500,
    "onHandWeightKG": 2500,
    "onHandVolumeM3": 12.5,
    "availableQuantity": 450,
    "allocatedQuantity": 50
  }
]

Stock On Hand Excel Export

Download stock on hand report as Excel file.

Endpoint: POST /v1/reports/stock-on-hand/xlsx

Request Body

Same as JSON endpoint.

Request Example 

curl -X POST "https://api.consignlyhq.com/v1/reports/stock-on-hand/xlsx" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"warehouseId": "550e8400-e29b-41d4-a716-446655446000"}' \
  --output stock-on-hand.xlsx

Response

Binary Excel file download.

Inward Consignment Summary Report

Get summary of inward consignments.

Endpoint: POST /v1/reports/inward-consignment-summary

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "partnerId": "550e8400-e29b-41d4-a716-446655446001",
  "modeType": 1,
  "dateFrom": "2024-01-01",
  "dateTo": "2024-01-31"
}
Field Type Required Description
warehouseId uuid No Filter by warehouse
partnerId uuid No Filter by partner
modeType integer No Report mode (see values below)
dateFrom date No Start date
dateTo date No End date

Inward Report Mode Types

Value Mode Description
1 DateEntered By date entered
2 ActualReceivedDate By actual received date
3 NotYetReceived Not yet received

Request Example 

curl -X POST "https://api.consignlyhq.com/v1/reports/inward-consignment-summary" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "modeType": 1,
    "dateFrom": "2024-01-01",
    "dateTo": "2024-01-31"
  }'

Outward Consignment Summary Report

Get summary of outward consignments.

Endpoint: POST /v1/reports/outward-consignment-summary

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "partnerId": "550e8400-e29b-41d4-a716-446655446001",
  "modeType": 1,
  "dateFrom": "2024-01-01",
  "dateTo": "2024-01-31"
}

Outward Report Mode Types

Value Mode Description
1 DateEntered By date entered
2 ActualDispatchDate By actual dispatch date
3 NotYetDispatched Not yet dispatched

Stock Age Report

Analyze stock by age/days in warehouse.

Endpoint: POST /v1/reports/stock-age

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "partnerId": "550e8400-e29b-41d4-a716-446655446001",
  "ageBrackets": [30, 60, 90, 180]
}
Field Type Required Description
warehouseId uuid No Filter by warehouse
partnerId uuid No Filter by partner
ageBrackets integer[] No Age brackets in days

Location Status Report

Report on warehouse location utilization.

Endpoint: POST /v1/reports/location-status

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "warehouseZoneId": "550e8400-e29b-41d4-a716-446655446020"
}

Pickface Exception Report

Identify pickface locations needing attention.

Endpoint: POST /v1/reports/pickface-exception

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000"
}

Pickface Replenishment Report

Identify pickfaces requiring replenishment.

Endpoint: POST /v1/reports/pickface-replenishment

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "partnerId": "550e8400-e29b-41d4-a716-446655446001"
}

Product Transaction Detail Report

Detailed product transaction history.

Endpoint: POST /v1/reports/product-transaction-detail

Request Body 

{
  "warehouseId": "550e8400-e29b-41d4-a716-446655446000",
  "partnerId": "550e8400-e29b-41d4-a716-446655446001",
  "partnerProductId": "550e8400-e29b-41d4-a716-446655446010",
  "dateFrom": "2024-01-01",
  "dateTo": "2024-01-31"
}

Excel Export Pattern

All reports with /xlsx suffix follow the same pattern:

  • Same request body as JSON endpoint
  • Returns binary Excel file
  • Add --output filename.xlsx to curl command

Error Cases

Status Cause Resolution
400 Invalid date range Check date format (YYYY-MM-DD)
400 Invalid filter IDs Verify UUIDs exist
401 Unauthorized Check authentication

Related Endpoints

Previous
Product Attributes
Next
Revenue Accounts