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/pick-performance |
Pick performance report |
POST |
/v1/reports/pick-performance/xlsx |
Pick performance 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
[
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-01",
"clientName": "Example Client",
"productCode": "PROD-A",
"productName": "Product A",
"logisticUnit": {
"packageTypeName": "Blue Pallet",
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"serial": "SER-001",
"batch": "BATCH-001",
"bestBeforeDate": "2025-11-30",
"expiryDate": "2025-12-31",
"packagingDate": "2024-01-10",
"productionDate": "2024-01-01",
"sellByDate": "2025-10-31",
"attributes": [
{
"name": "Color",
"description": "Blue"
}
],
"isCritical": false,
"productGroupName": "General Goods",
"unitTypeName": "Carton",
"onHandQuantity": 500,
"onHandVolumeM3": 12.5,
"onHandWeightKG": 2500,
"onHandVirtualPalletQuantity": 20
},
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-02",
"clientName": "Example Client",
"productCode": "PROD-B",
"productName": "Product B",
"logisticUnit": null,
"serial": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"attributes": [],
"isCritical": false,
"productGroupName": "General Goods",
"unitTypeName": "Carton",
"onHandQuantity": 120,
"onHandVolumeM3": 3.0,
"onHandWeightKG": 600,
"onHandVirtualPalletQuantity": 5
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
warehouseCode |
string | Code of the warehouse. |
warehouseName |
string | Name of the warehouse. |
warehouseLocationName |
string | Name of the warehouse location. |
clientName |
string | Name of the client partner. |
productCode |
string | Product code. |
productName |
string | Product name. |
logisticUnit |
object | Nested logistic unit identifiers (packageTypeName, logisticUnitNumber, ssccNumber, referenceNumber), or null when no logistic unit is assigned. |
logisticUnit.packageTypeName |
string (nullable) | The package type name from the logistic unit, or null when the logistic unit has no assigned package type. |
logisticUnit.logisticUnitNumber |
string | Number of the logistic unit. |
logisticUnit.ssccNumber |
string | SSCC number of the logistic unit. |
logisticUnit.referenceNumber |
string | Reference number of the logistic unit. |
serial |
string | Serial tracking value, if present. |
batch |
string | Batch identifier, if present. |
bestBeforeDate |
date-time | Best before date, if present. |
expiryDate |
date-time | Expiry date, if present. |
packagingDate |
date-time | Packaging date, if present. |
productionDate |
date-time | Production date, if present. |
sellByDate |
date-time | Sell by date, if present. |
attributes |
array | Product attributes array (name, description). |
isCritical |
boolean | Indicates if stock is critical based on date thresholds. |
productGroupName |
string | Product group name. |
unitTypeName |
string | Stocked unit type name. |
onHandQuantity |
number | Physical quantity on hand. |
onHandVolumeM3 |
number | Volume on hand in cubic metres. |
onHandWeightKG |
number | Weight on hand in kilograms. |
onHandVirtualPalletQuantity |
number | Quantity in virtual pallets. |
Stock On Hand Excel Export
Download stock on hand report as Excel file.
When logistic unit features are enabled for the organisation, the Excel export includes a Package Type column placed immediately before Package Number. If an item has no package type assigned, the Package Type cell is blank.
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"
}'
Consignment Metrics Report
Get consignment metrics for consignments in a date range.
Endpoint: POST /v1/reports/consignment-metrics
The request requires an authorised custom application or middleware integration, the report token scope, and the consignment metrics report permission.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date-time | Yes | Start of the consignment date range. |
dateTo |
date-time | Yes | End of the consignment date range. Must be on or after dateFrom; the range cannot exceed 200 days. |
consignmentType |
integer | No | Filter by consignment type. |
clientPartnerId |
uuid | No | Filter by client partner. |
carrierPartnerId |
uuid | No | Filter by carrier partner. |
warehouseId |
uuid | No | Filter by warehouse. |
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/consignment-metrics" \
-H "Authorization: ******" \
-H "Content-Type: application/json" \
-d '{
"dateFrom": "2024-01-01T00:00:00Z",
"dateTo": "2024-01-31T00:00:00Z",
"consignmentType": 2,
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"carrierPartnerId": "550e8400-e29b-41d4-a716-446655446002",
"warehouseId": "550e8400-e29b-41d4-a716-446655446000"
}'
Response Example
[
{
"clientName": "Example Client",
"dateEntered": "2024-01-15T08:30:00Z",
"type": 2,
"consignmentNumber": "CON-100045",
"referenceNumber": "REF-100045",
"carrierName": "Fast Freight",
"consigneeName": "Receiver Pty Ltd",
"poNumber": "PO-100045",
"soNumber": "SO-100045",
"receiversReference": "RECV-100045",
"sendersReference": "SEND-100045",
"warehouseName": "Main Warehouse",
"serviceTypeNames": ["Standard"],
"quantity": 12,
"weightKG": 250.5,
"volumeM3": 1.85,
"packages": 0,
"virtualPalletQuantity": 0,
"virtualPalletPartThereofQuantity": 0
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
clientName |
string | Name of the client partner. |
dateEntered |
date-time | Date and time the consignment was entered. |
type |
integer | Consignment type: 0 = Point to Point, 1 = Inwards, 2 = Outwards. |
consignmentNumber |
string | Consignment number. |
referenceNumber |
string | Consignment reference number. |
carrierName |
string | Name of the carrier. |
consigneeName |
string | Name of the consignee. |
poNumber |
string | Consignment purchase order number. |
soNumber |
string | Consignment sales order number. |
receiversReference |
string | Receiver's reference for the consignment. |
sendersReference |
string | Sender's reference for the consignment. |
warehouseName |
string | Name of the warehouse. |
serviceTypeNames |
string array | Names of the consignment's service types. |
quantity |
number | Product quantity in the consignment; distinct from packages. |
weightKG |
number | Product weight in kilograms. |
volumeM3 |
number | Product volume in cubic metres. |
packages |
integer or null | Number of logistic units directly attached to the consignment when logistic-unit features are enabled. It is 0 when no units are attached. When the feature is disabled, the field is present with a null value. It is not a recursive nested-unit count or product quantity. |
virtualPalletQuantity |
number | Virtual pallet quantity of the products; distinct from the physical package count. |
virtualPalletPartThereofQuantity |
number | Virtual pallet (or part thereof) quantity of the products; distinct from the physical package count. |
The Portal consignment metrics report uses the same direct linked-logistic-unit count and feature gating. Its JSON field is named packagesCount; the public API field is packages.
Invalid or excessive date ranges return 400 Bad Request.
Consignment Metrics Excel Export
Download consignment metrics as an Excel workbook.
Endpoint: POST /v1/reports/consignment-metrics/xlsx
The request body and access requirements are the same as the Consignment Metrics Report.
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/consignment-metrics/xlsx" \
-H "Authorization: ******" \
-H "Content-Type: application/json" \
-d '{
"dateFrom": "2024-01-01T00:00:00Z",
"dateTo": "2024-01-31T00:00:00Z"
}' \
--output consignment-metrics.xlsx
Response
Binary Excel workbook download.
When logistic-unit features are enabled, the workbook includes a Packages column with the number of logistic units directly attached to each consignment; zero attached units are reported as 0. When the feature is disabled, the Packages column is omitted. The Virtual Pallets and Virtual Pallets (Or Part Thereof) columns remain separate virtual-pallet metrics.
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 |
Consignment Product Dispatched Report
Get product quantities and consignment details for consignments dispatched in the requested date range.
Endpoint: POST /v1/reports/consignment-product-dispatched
Request Body
{
"dateFrom": "2025-01-01T00:00:00Z",
"dateTo": "2025-01-31T23:59:59Z",
"clientPartnerId": null,
"warehouseId": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null
}
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date-time | Yes | Start of the dispatched date range. |
dateTo |
date-time | Yes | End of the dispatched date range; must be on or after dateFrom. |
clientPartnerId |
uuid | No | Filter by client partner. |
warehouseId |
uuid | No | Filter by warehouse. |
batch |
string | No | Filter by product batch. |
bestBeforeDate |
date-time | No | Filter by product best-before date. |
expiryDate |
date-time | No | Filter by product expiry date. |
packagingDate |
date-time | No | Filter by product packaging date. |
productionDate |
date-time | No | Filter by product production date. |
sellByDate |
date-time | No | Filter by product sell-by date. |
Response Example
The following rows show a logistic unit with a null package type name, and a product with no logistic unit. Other response fields are omitted from this example and listed below.
[
{
"clientName": "Example Client",
"consignmentNumber": "OUT-001",
"actualDispatchDateTime": "2025-01-12T10:30:00Z",
"logisticUnit": {
"packageTypeName": null,
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"productCode": "PROD-A",
"productName": "Product A",
"dispatchedQuantity": 10
},
{
"clientName": "Example Client",
"consignmentNumber": "OUT-002",
"actualDispatchDateTime": "2025-01-13T09:00:00Z",
"logisticUnit": null,
"productCode": "PROD-B",
"productName": "Product B",
"dispatchedQuantity": 5
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
clientName |
string | Client partner name. |
consignmentNumber |
string | Consignment number. |
referenceNumber |
string | Consignment reference number. |
actualDispatchDateTime |
date-time | Actual dispatch date and time. |
poNumber |
string | Consignment purchase order number. |
soNumber |
string | Consignment sales order number. |
receiversReference |
string | Receiver's reference. |
sendersReference |
string | Sender's reference. |
warehouseName |
string | Warehouse name. |
serviceTypeNames |
array of string | Names of the consignment service types. |
carrierName |
string | Carrier name. |
carrierReferenceNumber |
string | Carrier reference number. |
originAddressName |
string | Origin address name. |
originAddressText |
string | Origin address. |
destinationAddressName |
string | Destination address name. |
destinationAddressText |
string | Destination address. |
containerNumber |
string | Container number. |
containerSize |
enum (nullable) | Container size. |
vesselName |
string | Vessel name. |
voyage |
string | Voyage. |
sealNumber |
string | Seal number. |
containerTareWeightKG |
number (nullable) | Container tare weight in kilograms. |
containerGrossWeightKG |
number (nullable) | Container gross weight in kilograms. |
dischargeShippingPortCode |
string | Discharge shipping port code. |
loadShippingPortCode |
string | Load shipping port code. |
logisticUnit |
object (nullable) | Logistic unit details, or null when the product has no logistic unit. |
logisticUnit.packageTypeName |
string (nullable) | Package type name, or null when no package type is assigned. |
logisticUnit.logisticUnitNumber |
string | Logistic unit number. |
logisticUnit.ssccNumber |
string | Logistic unit SSCC number. |
logisticUnit.referenceNumber |
string | Logistic unit reference number. |
productCode |
string | Product code. |
productName |
string | Product name. |
batch |
string | Product batch. |
bestBeforeDate |
date-time (nullable) | Product best-before date. |
expiryDate |
date-time (nullable) | Product expiry date. |
packagingDate |
date-time (nullable) | Product packaging date. |
productionDate |
date-time (nullable) | Product production date. |
sellByDate |
date-time (nullable) | Product sell-by date. |
attributes |
array | Product attributes; each item has name and description string fields. |
expectedQuantity |
number | Expected product quantity. |
expectedWeightKG |
number | Expected product weight in kilograms. |
expectedVolumeM3 |
number | Expected product volume in cubic metres. |
dispatchedQuantity |
number | Dispatched product quantity. |
dispatchedWeightKG |
number | Dispatched product weight in kilograms. |
dispatchedVolumeM3 |
number | Dispatched product volume in cubic metres. |
Consignment Product Dispatched Excel Export
Download the dispatched product report as an Excel file.
Endpoint: POST /v1/reports/consignment-product-dispatched/xlsx
The request body is the same as the JSON endpoint. The response is a binary Excel file download. When logistic unit features are enabled for the organisation, the export includes a Package Type column immediately before Package Number. These columns are not shown when the logistic unit feature gate is off.
Consignment Product Detail Report
Get product details and consignment information for the requested date range.
Endpoint: POST /v1/reports/consignment-product-detail
Request Body
{
"dateFrom": "2025-01-01T00:00:00Z",
"dateTo": "2025-01-31T23:59:59Z",
"consignmentType": null,
"clientPartnerId": null,
"warehouseId": null,
"partnerProductId": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null
}
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date-time | Yes | Start of the consignment date range. |
dateTo |
date-time | Yes | End of the consignment date range; must be on or after dateFrom. |
consignmentType |
enum (nullable) | No | Filter by consignment type. |
clientPartnerId |
uuid | No | Filter by client partner. |
warehouseId |
uuid | No | Filter by warehouse. |
partnerProductId |
uuid | No | Filter by product. |
batch |
string | No | Filter by product batch. |
bestBeforeDate |
date-time | No | Filter by product best-before date. |
expiryDate |
date-time | No | Filter by product expiry date. |
packagingDate |
date-time | No | Filter by product packaging date. |
productionDate |
date-time | No | Filter by product production date. |
sellByDate |
date-time | No | Filter by product sell-by date. |
Response Example
The following rows show a logistic unit with a null package type name, and a product with no logistic unit. Other response fields are omitted from this example and listed below.
[
{
"clientName": "Example Client",
"consignmentNumber": "OUT-001",
"dateEntered": "2025-01-10T08:00:00Z",
"logisticUnit": {
"packageTypeName": null,
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"productCode": "PROD-A",
"productName": "Product A",
"quantity": 10
},
{
"clientName": "Example Client",
"consignmentNumber": "OUT-002",
"dateEntered": "2025-01-11T08:00:00Z",
"logisticUnit": null,
"productCode": "PROD-B",
"productName": "Product B",
"quantity": 5
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
clientName |
string | Client partner name. |
type |
enum | Consignment type. |
consignmentNumber |
string | Consignment number. |
referenceNumber |
string | Consignment reference number. |
dateEntered |
date-time | Date and time the consignment was entered. |
actualDispatchDateTime |
date-time (nullable) | Actual dispatch date and time, if dispatched. |
poNumber |
string | Consignment purchase order number. |
soNumber |
string | Consignment sales order number. |
receiversReference |
string | Receiver's reference. |
sendersReference |
string | Sender's reference. |
warehouseName |
string | Warehouse name. |
serviceTypeNames |
array of string | Names of the consignment service types. |
carrierName |
string | Carrier name. |
carrierReferenceNumber |
string | Carrier reference number. |
originAddressName |
string | Origin address name. |
originAddressText |
string | Origin address. |
destinationAddressName |
string | Destination address name. |
destinationAddressText |
string | Destination address. |
logisticUnit |
object (nullable) | Logistic unit details, or null when the product has no logistic unit. |
logisticUnit.packageTypeName |
string (nullable) | Package type name, or null when no package type is assigned. |
logisticUnit.logisticUnitNumber |
string | Logistic unit number. |
logisticUnit.ssccNumber |
string | Logistic unit SSCC number. |
logisticUnit.referenceNumber |
string | Logistic unit reference number. |
productCode |
string | Product code. |
productName |
string | Product name. |
batch |
string | Product batch. |
bestBeforeDate |
date-time (nullable) | Product best-before date. |
expiryDate |
date-time (nullable) | Product expiry date. |
packagingDate |
date-time (nullable) | Product packaging date. |
productionDate |
date-time (nullable) | Product production date. |
sellByDate |
date-time (nullable) | Product sell-by date. |
attributes |
array | Product attributes; each item has name and description string fields. |
unitTypeName |
string | Product unit type name. |
quantity |
number | Product quantity. |
weightKG |
number | Product weight in kilograms. |
volumeM3 |
number | Product volume in cubic metres. |
virtualPalletQuantity |
number (nullable) | Product quantity expressed in virtual pallets. |
Consignment Product Detail Excel Export
Download the consignment product detail report as an Excel file.
Endpoint: POST /v1/reports/consignment-product-detail/xlsx
The request body is the same as the JSON endpoint. The response is a binary Excel file download. When logistic unit features are enabled for the organisation, the export includes a Package Type column immediately before Package Number. These columns are not shown when the logistic unit feature gate is off.
Consignment Product Due Report
Get product quantities and consignment details for consignments due in the requested date range.
Endpoint: POST /v1/reports/consignment-product-due
Request Body
{
"dateFrom": "2025-01-01T00:00:00Z",
"dateTo": "2025-01-31T23:59:59Z",
"clientPartnerId": null,
"warehouseId": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null
}
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date-time | Yes | Start of the consignment date range. |
dateTo |
date-time | Yes | End of the consignment date range; must be on or after dateFrom. |
clientPartnerId |
uuid | No | Filter by client partner. |
warehouseId |
uuid | No | Filter by warehouse. |
batch |
string | No | Filter by product batch. |
bestBeforeDate |
date-time | No | Filter by product best-before date. |
expiryDate |
date-time | No | Filter by product expiry date. |
packagingDate |
date-time | No | Filter by product packaging date. |
productionDate |
date-time | No | Filter by product production date. |
sellByDate |
date-time | No | Filter by product sell-by date. |
Response Example
The following rows show a logistic unit with a null package type name, and a product with no logistic unit. Other response fields are omitted from this example and listed below.
[
{
"clientName": "Example Client",
"consignmentNumber": "IN-001",
"dateEntered": "2025-01-10T08:00:00Z",
"expectedArrivalDateTime": "2025-01-15T08:00:00Z",
"logisticUnit": {
"packageTypeName": null,
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"productCode": "PROD-A",
"productName": "Product A",
"quantity": 10
},
{
"clientName": "Example Client",
"consignmentNumber": "IN-002",
"dateEntered": "2025-01-11T08:00:00Z",
"expectedArrivalDateTime": null,
"logisticUnit": null,
"productCode": "PROD-B",
"productName": "Product B",
"quantity": 5
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
clientName |
string | Client partner name. |
consignmentNumber |
string | Consignment number. |
referenceNumber |
string | Consignment reference number. |
dateEntered |
date-time | Date and time the consignment was entered. |
expectedArrivalDateTime |
date-time (nullable) | Expected arrival date and time. |
poNumber |
string | Consignment purchase order number. |
soNumber |
string | Consignment sales order number. |
receiversReference |
string | Receiver's reference. |
sendersReference |
string | Sender's reference. |
warehouseName |
string | Warehouse name. |
serviceTypeNames |
array of string | Names of the consignment service types. |
carrierName |
string | Carrier name. |
carrierReferenceNumber |
string | Carrier reference number. |
originAddressName |
string | Origin address name. |
originAddressText |
string | Origin address. |
destinationAddressName |
string | Destination address name. |
destinationAddressText |
string | Destination address. |
containerNumber |
string | Container number. |
containerSize |
enum (nullable) | Container size. |
vesselName |
string | Vessel name. |
voyage |
string | Voyage. |
sealNumber |
string | Seal number. |
containerTareWeightKG |
number (nullable) | Container tare weight in kilograms. |
containerGrossWeightKG |
number (nullable) | Container gross weight in kilograms. |
dischargeShippingPortCode |
string | Discharge shipping port code. |
loadShippingPortCode |
string | Load shipping port code. |
logisticUnit |
object (nullable) | Logistic unit details, or null when the product has no logistic unit. |
logisticUnit.packageTypeName |
string (nullable) | Package type name, or null when no package type is assigned. |
logisticUnit.logisticUnitNumber |
string | Logistic unit number. |
logisticUnit.ssccNumber |
string | Logistic unit SSCC number. |
logisticUnit.referenceNumber |
string | Logistic unit reference number. |
productCode |
string | Product code. |
productName |
string | Product name. |
batch |
string | Product batch. |
bestBeforeDate |
date-time (nullable) | Product best-before date. |
expiryDate |
date-time (nullable) | Product expiry date. |
packagingDate |
date-time (nullable) | Product packaging date. |
productionDate |
date-time (nullable) | Product production date. |
sellByDate |
date-time (nullable) | Product sell-by date. |
attributes |
array | Product attributes; each item has name and description string fields. |
quantity |
number | Product quantity. |
weightKG |
number | Product weight in kilograms. |
volumeM3 |
number | Product volume in cubic metres. |
Consignment Product Due Excel Export
Download the consignment product due report as an Excel file.
Endpoint: POST /v1/reports/consignment-product-due/xlsx
The request body is the same as the JSON endpoint. The response is a binary Excel file download. When logistic unit features are enabled for the organisation, the export includes a Package Type column immediately before Package Number. These columns are not shown when the logistic unit feature gate is off.
Consignment Product Received Report
Get product quantities and consignment details for consignments received in the requested date range.
Endpoint: POST /v1/reports/consignment-product-received
Request Body
{
"dateFrom": "2025-01-01T00:00:00Z",
"dateTo": "2025-01-31T23:59:59Z",
"clientPartnerId": null,
"warehouseId": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null
}
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date-time | Yes | Start of the received date range. |
dateTo |
date-time | Yes | End of the received date range; must be on or after dateFrom. |
clientPartnerId |
uuid | No | Filter by client partner. |
warehouseId |
uuid | No | Filter by warehouse. |
batch |
string | No | Filter by product batch. |
bestBeforeDate |
date-time | No | Filter by product best-before date. |
expiryDate |
date-time | No | Filter by product expiry date. |
packagingDate |
date-time | No | Filter by product packaging date. |
productionDate |
date-time | No | Filter by product production date. |
sellByDate |
date-time | No | Filter by product sell-by date. |
Response Example
The following rows show a logistic unit with a null package type name, and a product with no logistic unit. Other response fields are omitted from this example and listed below.
[
{
"clientName": "Example Client",
"consignmentNumber": "IN-001",
"actualReceiveDateTime": "2025-01-12T10:30:00Z",
"logisticUnit": {
"packageTypeName": null,
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"productCode": "PROD-A",
"productName": "Product A",
"receivedQuantity": 10
},
{
"clientName": "Example Client",
"consignmentNumber": "IN-002",
"actualReceiveDateTime": "2025-01-13T09:00:00Z",
"logisticUnit": null,
"productCode": "PROD-B",
"productName": "Product B",
"receivedQuantity": 5
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
clientName |
string | Client partner name. |
consignmentNumber |
string | Consignment number. |
referenceNumber |
string | Consignment reference number. |
actualReceiveDateTime |
date-time | Actual receive date and time. |
poNumber |
string | Consignment purchase order number. |
soNumber |
string | Consignment sales order number. |
receiversReference |
string | Receiver's reference. |
sendersReference |
string | Sender's reference. |
warehouseName |
string | Warehouse name. |
serviceTypeNames |
array of string | Names of the consignment service types. |
carrierName |
string | Carrier name. |
carrierReferenceNumber |
string | Carrier reference number. |
originAddressName |
string | Origin address name. |
originAddressText |
string | Origin address. |
destinationAddressName |
string | Destination address name. |
destinationAddressText |
string | Destination address. |
containerNumber |
string | Container number. |
containerSize |
enum (nullable) | Container size. |
vesselName |
string | Vessel name. |
voyage |
string | Voyage. |
sealNumber |
string | Seal number. |
containerTareWeightKG |
number (nullable) | Container tare weight in kilograms. |
containerGrossWeightKG |
number (nullable) | Container gross weight in kilograms. |
dischargeShippingPortCode |
string | Discharge shipping port code. |
loadShippingPortCode |
string | Load shipping port code. |
logisticUnit |
object (nullable) | Logistic unit details, or null when the product has no logistic unit. |
logisticUnit.packageTypeName |
string (nullable) | Package type name, or null when no package type is assigned. |
logisticUnit.logisticUnitNumber |
string | Logistic unit number. |
logisticUnit.ssccNumber |
string | Logistic unit SSCC number. |
logisticUnit.referenceNumber |
string | Logistic unit reference number. |
productCode |
string | Product code. |
productName |
string | Product name. |
batch |
string | Product batch. |
bestBeforeDate |
date-time (nullable) | Product best-before date. |
expiryDate |
date-time (nullable) | Product expiry date. |
packagingDate |
date-time (nullable) | Product packaging date. |
productionDate |
date-time (nullable) | Product production date. |
sellByDate |
date-time (nullable) | Product sell-by date. |
attributes |
array | Product attributes; each item has name and description string fields. |
expectedQuantity |
number | Expected product quantity. |
expectedWeightKG |
number | Expected product weight in kilograms. |
expectedVolumeM3 |
number | Expected product volume in cubic metres. |
receivedQuantity |
number | Received product quantity. |
receivedWeightKG |
number | Received product weight in kilograms. |
receivedVolumeM3 |
number | Received product volume in cubic metres. |
Consignment Product Received Excel Export
Download the consignment product received report as an Excel file.
Endpoint: POST /v1/reports/consignment-product-received/xlsx
The request body is the same as the JSON endpoint. The response is a binary Excel file download. When logistic unit features are enabled for the organisation, the export includes a Package Type column immediately before Package Number. These columns are not shown when the logistic unit feature gate is off.
Stock Age Report
Analyze stock by age/days in warehouse.
Endpoint: POST /v1/reports/stock-age
Request Body
{
"warehouseId": "550e8400-e29b-41d4-a716-446655446000",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"reportTime": 1,
"includeDateAndTime": false,
"includeCriticalStockOnly": false
}
| Field | Type | Required | Description |
|---|---|---|---|
reportTime |
integer or string | No | Mode for report point-in-time calculation: 1 / Now (default) or 2 / Custom. |
customDateTime |
date-time | Conditional | Required when reportTime is 2 (Custom). The point-in-time timestamp evaluated for stock age. |
warehouseId |
uuid | No | Filter by warehouse. |
clientPartnerId |
uuid | No | Filter by client partner. |
partnerProductId |
uuid | No | Filter by product. |
productGroupId |
uuid | No | Filter by product group. |
batch |
string | No | Filter by product batch. |
bestBeforeDate |
date | No | Filter by best before date. |
expiryDate |
date | No | Filter by expiry date. |
packagingDate |
date | No | Filter by packaging date. |
productionDate |
date | No | Filter by production date. |
sellByDate |
date | No | Filter by sell by date. |
includeDateAndTime |
boolean | No | Include both date and time in exported/evaluated dates (default: false). |
includeCriticalStockOnly |
boolean | No | Filter report to only include stock identified as critical (default: false). |
productAttributeId |
uuid | No | Filter by product attribute. |
attributeDescription |
string | No | Filter by attribute description. |
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/stock-age" \
-H "Authorization: ******" \
-H "Content-Type: application/json" \
-d '{
"warehouseId": "550e8400-e29b-41d4-a716-446655446000",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"reportTime": 1,
"includeCriticalStockOnly": false
}'
Response Example
[
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-01",
"clientName": "Example Client",
"productCode": "PROD-A",
"productName": "Product A",
"logisticUnit": {
"packageTypeName": "Standard Wooden Pallet",
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"batch": "BATCH-001",
"bestBeforeDate": "2025-11-30T00:00:00Z",
"expiryDate": "2025-12-31T00:00:00Z",
"packagingDate": "2024-01-10T00:00:00Z",
"productionDate": "2024-01-01T00:00:00Z",
"sellByDate": "2025-10-31T00:00:00Z",
"attributes": [
{
"name": "Color",
"description": "Blue"
}
],
"isCritical": false,
"productGroupName": "General Goods",
"serial": "SER-001",
"receivedUtc": "2024-01-01T00:00:00Z",
"freeStorageExpiryUtc": "2024-01-15T00:00:00Z",
"unitTypeName": "Carton",
"onHandQuantity": 200,
"onHandVolumeM3": 5.0,
"onHandWeightKG": 1000,
"onHandVirtualPalletQuantity": 8
},
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-02",
"clientName": "Example Client",
"productCode": "PROD-B",
"productName": "Product B",
"logisticUnit": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"attributes": [],
"isCritical": false,
"productGroupName": "General Goods",
"serial": null,
"receivedUtc": "2024-02-01T00:00:00Z",
"freeStorageExpiryUtc": null,
"unitTypeName": "Carton",
"onHandQuantity": 50,
"onHandVolumeM3": 1.25,
"onHandWeightKG": 250,
"onHandVirtualPalletQuantity": 2
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
warehouseCode |
string | Code of the warehouse. |
warehouseName |
string | Name of the warehouse. |
warehouseLocationName |
string | Name of the warehouse location. |
clientName |
string | Name of the client partner. |
productCode |
string | Product code. |
productName |
string | Product name. |
logisticUnit |
object | Nested logistic unit identifiers (packageTypeName, logisticUnitNumber, ssccNumber, referenceNumber), or null when no logistic unit is assigned. |
logisticUnit.packageTypeName |
string (nullable) | The package type name from the logistic unit, or null when the logistic unit has no assigned package type. |
logisticUnit.logisticUnitNumber |
string | Number of the logistic unit. |
logisticUnit.ssccNumber |
string | SSCC number of the logistic unit. |
logisticUnit.referenceNumber |
string | Reference number of the logistic unit. |
batch |
string | Batch identifier, if present. |
bestBeforeDate |
date-time | Best before date, if present. |
expiryDate |
date-time | Expiry date, if present. |
packagingDate |
date-time | Packaging date, if present. |
productionDate |
date-time | Production date, if present. |
sellByDate |
date-time | Sell by date, if present. |
attributes |
array | Product attributes array (name, description). |
isCritical |
boolean | Indicates if stock is critical based on date thresholds. |
productGroupName |
string | Product group name. |
serial |
string | Serial tracking value, if present. |
receivedUtc |
date-time | UTC timestamp when the stock was received into the warehouse. |
freeStorageExpiryUtc |
date-time | UTC timestamp when free storage expires. |
unitTypeName |
string | Stocked unit type name. |
onHandQuantity |
number | Physical quantity on hand. |
onHandVolumeM3 |
number | Volume on hand in cubic metres. |
onHandWeightKG |
number | Weight on hand in kilograms. |
onHandVirtualPalletQuantity |
number | Quantity in virtual pallets. |
Stock Age Excel Export
Endpoint: POST /v1/reports/stock-age/xlsx
When logistic unit features are enabled for the organisation, the Excel export includes a Package Type column placed immediately before Package Number. If an item has no package type assigned, the Package Type cell is blank.
Stock Position Report
Analyze current stock positions, balances, and hold quantities across locations.
Endpoint: POST /v1/reports/stock-position
Request Body
{
"warehouseId": "550e8400-e29b-41d4-a716-446655446000",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"reportTime": 1,
"includeSerials": true,
"includeCriticalStockOnly": false,
"includeReceivedDates": true
}
| Field | Type | Required | Description |
|---|---|---|---|
reportTime |
integer or string | No | Mode for report point-in-time calculation: 1 / Now (default) or 2 / Custom. |
customDateTime |
date-time | Conditional | Required when reportTime is 2 (Custom). The point-in-time timestamp evaluated for stock position. |
warehouseId |
uuid | No | Filter by warehouse |
clientPartnerId |
uuid | No | Filter by client partner |
partnerProductId |
uuid | No | Filter by product |
productGroupId |
uuid | No | Filter by product group |
batch |
string | No | Filter by product batch |
bestBeforeDate |
date | No | Filter by best before date |
expiryDate |
date | No | Filter by expiry date |
packagingDate |
date | No | Filter by packaging date |
productionDate |
date | No | Filter by production date |
sellByDate |
date | No | Filter by sell by date |
includeSerials |
boolean | No | Include serial tracking numbers (default: false). When false, the serial field in response items is null. |
includeCriticalStockOnly |
boolean | No | Only include critical stock |
includeReceivedDates |
boolean | No | Include received dates |
productAttributeId |
uuid | No | Filter by product attribute |
attributeDescription |
string | No | Filter by attribute description |
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/stock-position" \
-H "Authorization: ******" \
-H "Content-Type: application/json" \
-d '{
"warehouseId": "550e8400-e29b-41d4-a716-446655446000",
"reportTime": 1,
"includeSerials": true,
"includeReceivedDates": true
}'
Response Example
[
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-01",
"clientName": "Example Client",
"productCode": "PROD-A",
"productName": "Product A",
"logisticUnit": {
"packageTypeName": "Standard Wooden Pallet",
"logisticUnitNumber": "LU-10001",
"ssccNumber": "123456789012345678",
"referenceNumber": "LU-REF-001"
},
"serial": "SER-001",
"unitTypeName": "Carton",
"batch": "BATCH-001",
"bestBeforeDate": "2025-11-30T00:00:00Z",
"expiryDate": "2025-12-31T00:00:00Z",
"packagingDate": "2024-01-10T00:00:00Z",
"productionDate": "2024-01-01T00:00:00Z",
"sellByDate": "2025-10-31T00:00:00Z",
"isCritical": false,
"attributes": [
{
"name": "Color",
"description": "Blue"
}
],
"productGroupName": "General Goods",
"onHandQuantity": 500,
"onHandVolumeM3": 12.5,
"onHandWeightKG": 2500,
"onHandVirtualPalletQuantity": 20,
"availableQuantity": 450,
"availableVolumeM3": 11.25,
"availableWeightKG": 2250,
"availableVirtualPalletQuantity": 18,
"allocatedQuantity": 50,
"allocatedVolumeM3": 1.25,
"allocatedWeightKG": 250,
"allocatedVirtualPalletQuantity": 2,
"jobHoldQuantity": 0,
"jobHoldVolumeM3": 0,
"jobHoldWeightKG": 0,
"jobHoldVirtualPalletQuantity": 0,
"generalHoldQuantity": 0,
"generalHoldVolumeM3": 0,
"generalHoldWeightKG": 0,
"generalHoldVirtualPalletQuantity": 0,
"qaHoldQuantity": 0,
"qaHoldVolumeM3": 0,
"qaHoldWeightKG": 0,
"qaHoldVirtualPalletQuantity": 0,
"returnHoldQuantity": 0,
"returnHoldVolumeM3": 0,
"returnHoldWeightKG": 0,
"returnHoldVirtualPalletQuantity": 0,
"receivedDate": "2024-01-15T00:00:00",
"receivedUtc": "2024-01-15T00:00:00Z"
},
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-02",
"clientName": "Example Client",
"productCode": "PROD-B",
"productName": "Product B",
"logisticUnit": null,
"serial": null,
"unitTypeName": "Carton",
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"isCritical": false,
"attributes": [],
"productGroupName": "General Goods",
"onHandQuantity": 100,
"onHandVolumeM3": 2.5,
"onHandWeightKG": 500,
"onHandVirtualPalletQuantity": 4,
"availableQuantity": 100,
"availableVolumeM3": 2.5,
"availableWeightKG": 500,
"availableVirtualPalletQuantity": 4,
"allocatedQuantity": 0,
"allocatedVolumeM3": 0,
"allocatedWeightKG": 0,
"allocatedVirtualPalletQuantity": 0,
"jobHoldQuantity": 0,
"jobHoldVolumeM3": 0,
"jobHoldWeightKG": 0,
"jobHoldVirtualPalletQuantity": 0,
"generalHoldQuantity": 0,
"generalHoldVolumeM3": 0,
"generalHoldWeightKG": 0,
"generalHoldVirtualPalletQuantity": 0,
"qaHoldQuantity": 0,
"qaHoldVolumeM3": 0,
"qaHoldWeightKG": 0,
"qaHoldVirtualPalletQuantity": 0,
"returnHoldQuantity": 0,
"returnHoldVolumeM3": 0,
"returnHoldWeightKG": 0,
"returnHoldVirtualPalletQuantity": 0,
"receivedDate": null,
"receivedUtc": null
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
warehouseCode |
string | Code of the warehouse. |
warehouseName |
string | Name of the warehouse. |
warehouseLocationName |
string | Name of the warehouse location. |
clientName |
string | Name of the client partner. |
productCode |
string | Product code. |
productName |
string | Product name. |
logisticUnit |
object | Nested logistic unit identifiers (packageTypeName, logisticUnitNumber, ssccNumber, referenceNumber), or null when no logistic unit is assigned. |
logisticUnit.packageTypeName |
string (nullable) | The package type name from the logistic unit, or null when the logistic unit has no assigned package type. |
logisticUnit.logisticUnitNumber |
string | Number of the logistic unit. |
logisticUnit.ssccNumber |
string | SSCC number of the logistic unit. |
logisticUnit.referenceNumber |
string | Reference number of the logistic unit. |
serial |
string | Serial tracking value, if present. Populated only when includeSerials is true in the request; otherwise null. |
unitTypeName |
string | Stocked unit type name. |
batch |
string | Batch identifier, if present. |
bestBeforeDate |
date-time | Best before date, if present. |
expiryDate |
date-time | Expiry date, if present. |
packagingDate |
date-time | Packaging date, if present. |
productionDate |
date-time | Production date, if present. |
sellByDate |
date-time | Sell by date, if present. |
isCritical |
boolean | Indicates if stock is critical based on date thresholds. |
attributes |
array | Product attributes array (name, description). |
productGroupName |
string | Product group name. |
onHandQuantity |
number | Physical quantity on hand. |
onHandVolumeM3 |
number | Volume on hand in cubic metres. |
onHandWeightKG |
number | Weight on hand in kilograms. |
onHandVirtualPalletQuantity |
number | Quantity in virtual pallets. |
availableQuantity |
number | Available quantity for allocation. |
availableVolumeM3 |
number | Available volume in cubic metres. |
availableWeightKG |
number | Available weight in kilograms. |
availableVirtualPalletQuantity |
number | Available virtual pallet quantity. |
allocatedQuantity |
number | Quantity allocated to consignments. |
allocatedVolumeM3 |
number | Volume allocated to consignments in cubic metres. |
allocatedWeightKG |
number | Weight allocated to consignments in kilograms. |
allocatedVirtualPalletQuantity |
number | Virtual pallet quantity allocated to consignments. |
jobHoldQuantity |
number | Quantity held on job hold. |
jobHoldVolumeM3 |
number | Volume on job hold in cubic metres. |
jobHoldWeightKG |
number | Weight on job hold in kilograms. |
jobHoldVirtualPalletQuantity |
number | Virtual pallet quantity on job hold. |
generalHoldQuantity |
number | Quantity held on general hold. |
generalHoldVolumeM3 |
number | Volume on general hold in cubic metres. |
generalHoldWeightKG |
number | Weight on general hold in kilograms. |
generalHoldVirtualPalletQuantity |
number | Virtual pallet quantity on general hold. |
qaHoldQuantity |
number | Quantity held on QA hold. |
qaHoldVolumeM3 |
number | Volume on QA hold in cubic metres. |
qaHoldWeightKG |
number | Weight on QA hold in kilograms. |
qaHoldVirtualPalletQuantity |
number | Virtual pallet quantity on QA hold. |
returnHoldQuantity |
number | Quantity held on return hold. |
returnHoldVolumeM3 |
number | Volume on return hold in cubic metres. |
returnHoldWeightKG |
number | Weight on return hold in kilograms. |
returnHoldVirtualPalletQuantity |
number | Virtual pallet quantity on return hold. |
receivedDate |
date-time | Received date in warehouse local time, if requested and present. |
receivedUtc |
date-time | Received timestamp in UTC, if requested and present. |
Stock Position Excel Export
Endpoint: POST /v1/reports/stock-position/xlsx
When logistic unit features are enabled for the organisation, the Excel export includes a Package Type column placed immediately before Package Number. If an item has no package type assigned, the Package Type cell is blank.
Stock Summary Report
Generate a summarized current inventory report with configurable field inclusions and automatic aggregation.
Note: Package type name inclusion and grouping is controlled via the optional
includePackageTypeNameparameter (defaults tofalsewhen omitted). Whentrue, each distinct package type creates a distinct summary group, with items lacking an assigned package type grouped undernull. Whenfalseor omitted, no grouping by package type occurs, andpackageTypeNameis returned asnullin the JSON response.
Endpoint: POST /v1/reports/stock-summary
Request Body
{
"warehouseId": "550e8400-e29b-41d4-a716-446655446000",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"includeClient": true,
"includeProduct": true,
"includeWarehouse": true,
"includeLocation": true,
"includeBatch": false,
"includePackageTypeName": true,
"includeProductGroup": true,
"includeUnitTypeName": true,
"includeVolume": true,
"includeWeight": true,
"includeVirtualPalletQuantity": true
}
| Field | Type | Required | Description |
|---|---|---|---|
warehouseId |
uuid | No | Filter by warehouse |
clientPartnerId |
uuid | No | Filter by client partner |
partnerProductId |
uuid | No | Filter by product |
productGroupId |
uuid | No | Filter by product group |
batch |
string | No | Filter by product batch |
bestBeforeDate |
date | No | Filter by best before date |
expiryDate |
date | No | Filter by expiry date |
packagingDate |
date | No | Filter by packaging date |
productionDate |
date | No | Filter by production date |
sellByDate |
date | No | Filter by sell by date |
includeCriticalStockOnly |
boolean | No | Only include critical stock |
productAttributeId |
uuid | No | Filter by product attribute |
attributeDescription |
string | No | Filter by attribute description |
includeClient |
boolean | No | Include and group by client partner |
includeProduct |
boolean | No | Include and group by product code and name |
includeWarehouse |
boolean | No | Include and group by warehouse code and name |
includeLocation |
boolean | No | Include and group by warehouse location |
includeBatch |
boolean | No | Include and group by batch |
includeBestBeforeDate |
boolean | No | Include and group by best before date |
includeExpiryDate |
boolean | No | Include and group by expiry date |
includePackagingDate |
boolean | No | Include and group by packaging date |
includeProductionDate |
boolean | No | Include and group by production date |
includeSellByDate |
boolean | No | Include and group by sell by date |
includeAttributes |
boolean | No | Include and group by product attributes |
includeIsCritical |
boolean | No | Include and group by critical stock flag |
includeProductGroup |
boolean | No | Include and group by product group |
includePackageTypeName |
boolean | No | Include and group by package type name (default: false) |
includeLogisticUnitNumber |
boolean | No | Include and group by logistic unit number |
includeLogisticUnitSSCCNumber |
boolean | No | Include and group by SSCC number |
includeLogisticUnitReferenceNumber |
boolean | No | Include and group by reference number |
includeReceivedDate |
boolean | No | Include and group by received date |
includeUnitTypeName |
boolean | No | Include and group by unit type name |
includeSerial |
boolean | No | Include and group by serial number |
includeVolume |
boolean | No | Calculate total volume on hand in m³ |
includeWeight |
boolean | No | Calculate total weight on hand in kg |
includeVirtualPalletQuantity |
boolean | No | Calculate total virtual pallet quantity |
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/stock-summary" \
-H "Authorization: ******" \
-H "Content-Type: application/json" \
-d '{
"warehouseId": "550e8400-e29b-41d4-a716-446655446000",
"includeClient": true,
"includeProduct": true,
"includeWarehouse": true,
"includeLocation": true,
"includePackageTypeName": true
}'
Response Example
[
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-01",
"clientName": "Example Client",
"productCode": "PROD-A",
"productName": "Product A",
"packageTypeName": "Standard Wooden Pallet",
"logisticUnitNumber": null,
"ssccNumber": null,
"referenceNumber": null,
"serial": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"attributes": null,
"isCritical": false,
"productGroupName": null,
"receivedDate": null,
"unitTypeName": null,
"onHandQuantity": 500,
"onHandVolumeM3": 0,
"onHandWeightKG": 0,
"onHandVirtualPalletQuantity": 0
},
{
"warehouseCode": "WH-001",
"warehouseName": "Main Warehouse",
"warehouseLocationName": "A1-01-02",
"clientName": "Example Client",
"productCode": "PROD-B",
"productName": "Product B",
"packageTypeName": null,
"logisticUnitNumber": null,
"ssccNumber": null,
"referenceNumber": null,
"serial": null,
"batch": null,
"bestBeforeDate": null,
"expiryDate": null,
"packagingDate": null,
"productionDate": null,
"sellByDate": null,
"attributes": null,
"isCritical": false,
"productGroupName": null,
"receivedDate": null,
"unitTypeName": null,
"onHandQuantity": 120,
"onHandVolumeM3": 0,
"onHandWeightKG": 0,
"onHandVirtualPalletQuantity": 0
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
warehouseCode |
string | Code of the warehouse (null if not included). |
warehouseName |
string | Name of the warehouse (null if not included). |
warehouseLocationName |
string | Name of the warehouse location (null if not included). |
clientName |
string | Name of the client partner (null if not included). |
productCode |
string | Product code (null if not included). |
productName |
string | Product name (null if not included). |
packageTypeName |
string (nullable) | The package type name from the logistic unit when includePackageTypeName is true, or null when not requested or when no package type is assigned to the unit. Note: JSON property ordering is non-contractual. |
logisticUnitNumber |
string | Number of the logistic unit (null if not included). |
ssccNumber |
string | SSCC number of the logistic unit (null if not included). |
referenceNumber |
string | Reference number of the logistic unit (null if not included). |
serial |
string | Serial tracking value (null if not included). |
batch |
string | Batch identifier (null if not included). |
bestBeforeDate |
date-time | Best before date (null if not included). |
expiryDate |
date-time | Expiry date (null if not included). |
packagingDate |
date-time | Packaging date (null if not included). |
productionDate |
date-time | Production date (null if not included). |
sellByDate |
date-time | Sell by date (null if not included). |
attributes |
array | Product attributes array (name, description), or null if not included. |
isCritical |
boolean | Indicates if stock is critical based on date thresholds. |
productGroupName |
string | Product group name (null if not included). |
receivedDate |
date-time | Date received in warehouse local time (null if not included). |
unitTypeName |
string | Stocked unit type name (null if not included). |
onHandQuantity |
number | Physical quantity on hand for this grouped aggregate. |
onHandVolumeM3 |
number | Volume on hand in cubic metres (0 if not included). |
onHandWeightKG |
number | Weight on hand in kilograms (0 if not included). |
onHandVirtualPalletQuantity |
number | Quantity in virtual pallets (0 if not included). |
Stock Summary Excel Export
Endpoint: POST /v1/reports/stock-summary/xlsx
The Excel export includes a Package Type column when logistic unit features are enabled for the organisation and includePackageTypeName: true is specified in the request. The optional Package Number column requires logistic unit features to be enabled for the organisation and includeLogisticUnitNumber: true. When Package Number is present, Package Type appears immediately before it. If an item has no package type assigned, the Package Type cell is blank.
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"
}
Pick Performance Report
Measure pick-to-dispatch performance for outward consignments, with one row per consignment and picked user.
Endpoint: POST /v1/reports/pick-performance
Request Body
{
"dateFrom": "2024-01-01",
"dateTo": "2024-01-31",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"userId": "550e8400-e29b-41d4-a716-446655440123",
"warehouseId": "550e8400-e29b-41d4-a716-446655446000"
}
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date | Yes | Start date in the dispatch date range |
dateTo |
date | Yes | End date in the dispatch date range |
clientPartnerId |
uuid | No | Filter by client partner |
userId |
uuid | No | Optional nominated picking user to filter by (blank / omitted includes all users) |
warehouseId |
uuid | No | Filter by warehouse |
Response Example
[
{
"clientName": "Example Client",
"clientCode": "CLIENT-01",
"consignmentNumber": "CON-100045",
"dateEntered": "2024-01-15T08:30:00Z",
"carrierName": "Fast Freight",
"originName": "Main Warehouse",
"originAddress": "1 Warehouse Way, Sydney NSW 2000",
"destinationName": "Receiver Pty Ltd",
"destinationAddress": "50 Delivery Rd, Melbourne VIC 3000",
"lineCount": 12,
"virtualPalletQuantity": 0.165,
"verifiedCount": 12,
"weightKG": 250.5,
"volumeM3": 1.85,
"firstPickedUtc": "2024-01-15T09:05:00Z",
"lastPickedUtc": "2024-01-15T09:45:00Z",
"pickDurationSeconds": 2400,
"lastDispatchedUtc": "2024-01-15T11:20:00Z",
"pickedToDispatchedSeconds": 8100,
"userName": "Jane Picker"
}
]
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/pick-performance" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"dateFrom": "2024-01-01",
"dateTo": "2024-01-31",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"userId": "550e8400-e29b-41d4-a716-446655440123",
"warehouseId": "550e8400-e29b-41d4-a716-446655446000"
}'
Pick Performance Excel Export
Download pick performance results as an Excel file.
Endpoint: POST /v1/reports/pick-performance/xlsx
Request Body
Same as the JSON endpoint.
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/pick-performance/xlsx" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"dateFrom": "2024-01-01",
"dateTo": "2024-01-31",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655440001",
"userId": "550e8400-e29b-41d4-a716-446655440123",
"warehouseId": "550e8400-e29b-41d4-a716-446655440000"
}' \
--output pick-performance.xlsx
Response
Binary Excel file download.
Client Charges Report
Get the results of the client charges report.
Endpoint: POST /v1/reports/client-charges
Request Body
{
"dateFrom": "2024-01-01",
"dateTo": "2024-01-31",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"transactionType": null,
"costCentreId": null,
"revenueAccountId": null
}
| Field | Type | Required | Description |
|---|---|---|---|
dateFrom |
date | Yes | Start date in the charge date range |
dateTo |
date | Yes | End date in the charge date range |
clientPartnerId |
uuid | No | Filter by client |
transactionType |
integer | No | Filter by partner transaction type |
costCentreId |
uuid | No | Filter by cost centre id |
revenueAccountId |
uuid | No | Filter by revenue account id |
Response Example
[
{
"clientName": "ABC Distributors",
"clientCode": "CLI-001",
"externalId": "EXT-100023",
"transactionDate": "2024-01-19",
"scheduleStatus": 1,
"scheduleReference": "SCH-2024-001",
"transactionType": 2,
"activityName": "Storage",
"activityCode": "STOR",
"particulars": "Palletized goods",
"consignmentNumber": "CON-100023",
"containerNumber": "CNU1234567",
"referenceNumber": "REF-88",
"consigneeName": "Receiver Pty Ltd",
"taxRatePercent": 15.0,
"quantity": 10.0,
"chargeRateExclTax": 12.5,
"chargeApplication": 1,
"baseChargeExclTax": 100.0,
"minChargeExclTax": 80.0,
"maxChargeExclTax": 200.0,
"amountExclTax": 125.0,
"costCentreCode": "CC-001",
"revenueAccountCode": "REV-001"
}
]
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/client-charges" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"dateFrom": "2024-01-01",
"dateTo": "2024-01-31",
"clientPartnerId": "550e8400-e29b-41d4-a716-446655446001",
"costCentreId": "550e8400-e29b-41d4-a716-446655446101",
"revenueAccountId": "550e8400-e29b-41d4-a716-446655446201"
}'
Client Charges Excel Export
Download client charges results as an Excel file.
Endpoint: POST /v1/reports/client-charges/xlsx
Request Body
Same as the JSON endpoint.
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/client-charges/xlsx" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"dateFrom": "2024-01-01",
"dateTo": "2024-01-31",
"costCentreId": "550e8400-e29b-41d4-a716-446655446101",
"revenueAccountId": "550e8400-e29b-41d4-a716-446655446201"
}' \
--output client-charges.xlsx
Response
Binary Excel file download.
Scheduled Transactions Report
Get the results of the scheduled transactions report.
Endpoint: POST /v1/reports/scheduled-transactions
Request Body
{
"scheduleDateFrom": "2024-01-01",
"scheduleDateTo": "2024-01-31",
"scheduleStatus": null,
"partnerRelationship": 1,
"partnerId": null
}
| Field | Type | Required | Description |
|---|---|---|---|
scheduleDateFrom |
date | Yes | Start date in the schedule date range |
scheduleDateTo |
date | Yes | End date in the schedule date range |
scheduleStatus |
integer | No | Filter by schedule status |
partnerRelationship |
integer | Yes | Filter by partner relationship |
partnerId |
uuid | No | Filter by specific partner |
Response Example
[
{
"partnerName": "ABC Distributors",
"scheduleDate": "2024-01-19",
"scheduleStatus": 1,
"referenceNumber": "SCH-2024-001",
"description": "Weekly storage and handling",
"transactionDate": "2024-01-18",
"transactionType": 2,
"activityName": "Storage",
"activityCode": "STOR",
"consignmentNumber": "CON-100023",
"containerNumber": "CNU1234567",
"consignmentReferenceNumber": "REF-88",
"revenueAccountCode": "REV-001",
"costCentreCode": "CC-001",
"particulars": "Palletized goods",
"taxRatePercent": 15.0,
"quantity": 10.0,
"chargeRateExclTax": 12.5,
"chargeApplication": 1,
"baseChargeExclTax": 100.0,
"minChargeExclTax": 80.0,
"maxChargeExclTax": 200.0,
"amountExclTax": 125.0
}
]
Request Example
curl -X POST "https://api.consignlyhq.com/v1/reports/scheduled-transactions" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"scheduleDateFrom": "2024-01-01",
"scheduleDateTo": "2024-01-31",
"scheduleStatus": null,
"partnerRelationship": 1,
"partnerId": null
}'
Scheduled Transactions Excel Export
Download scheduled transactions results as an Excel file.
Endpoint: POST /v1/reports/scheduled-transactions/xlsx
Request Body
Same as the JSON endpoint.
Response Example
Binary Excel file download.
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.xlsxto 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
- Inventory - Real-time inventory queries
- Consignments - Consignment management
- Warehouses - Warehouse information