Skip to main content
GET
Query Restock Suggestions

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Query Parameters

supplierId
string<uuid>
required

The ID of the supplier to generate suggestions for.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

timeFrameFrom
string<date-time>

Start of the consumption history window used for the demand forecast, inclusive (alternative to TimeFrameDays).

timeFrameTo
string<date-time>

End of the consumption history window used for the demand forecast, inclusive (alternative to TimeFrameDays).

timeFrameDays
integer<int32>

Days of consumption history used for the demand forecast, counted back from today (alternative to TimeFrameFrom/TimeFrameTo). The measured consumption is projected onto the next 30 days and added to the open demand, so sales orders still open inside the window count towards both.

warehouseId
string<uuid>

Optional warehouse to scope the calculation to. When set, demand is calculated for exactly this warehouse instead of the default target area. When omitted, the default target area is used.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

Success.

itemId
string<uuid>
required

Item ID.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

supplierId
string<uuid>
required

Supplier ID.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

warehouseId
string<uuid>
required

Warehouse ID.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

orderQuantity
number<decimal>
required

Suggested order quantity.

totalDemand
number<decimal>
required

Total demand.

awaitingDeliveryConsidered
number<decimal>
required

Awaiting delivery quantity considered for this warehouse.

awaitingDeliveryAllWarehouses
number<decimal>
required

Awaiting delivery quantity across all warehouses.

awaitingDeliveryTotal
number<decimal>
required

Total awaiting delivery quantity (complete).

stockTotal
number<decimal>
required

Total stock on hand.

consumptionXDays
number<decimal>
required

Consumption over X days.

demand30Days
number<decimal>
required

Demand over 30 days.

demandXDays
number<decimal>
required

Demand over X days.

dailyConsumption
number<decimal>
required

Daily consumption rate.

openOrderQuantity
number<decimal>
required

Open order quantity (reserved for orders).

supplierStock
number<decimal>
required

Supplier stock level.

minimumStock
number<decimal>
required

Local minimum stock level.

maximumStock
number<decimal>
required

Maximum stock level.

purchaseListQuantity
number<decimal>
required

Quantity on purchase list.

availabilityRequests
integer<int32>
required

Number of open customer availability requests for this item (pending demand not yet converted to orders).

isDefaultSupplier
boolean
required

Whether this is the default supplier for the item.

itemNumber
string

Stock keeping unit (item number).

itemName
string

Item name.

productGroup
string

Product group.

shippingClass
string

Shipping class.

manufacturerPartNumber
string

Manufacturer part number (HAN).

gtin
string

Global Trade Item Number (GTIN, formerly EAN).

manufacturer
string

Manufacturer name.

supplierItemNumber
string

Supplier-specific SKU.

supplierNote
string

Supplier note or remark.

warehouseName
string

Warehouse name.

demandSource
string

Demand source description.

supplySource
string

Supply source description.

availableTotal
number<decimal>

Total available quantity.

shortageTotal
number<decimal>

Total shortage quantity.

minimumStockGlobal
number<decimal>

Global minimum stock level.

permissibleOrderQuantity
number<decimal>

Permissible order quantity (step-size/multiple for supplier orders).

minimumOrderQuantity
integer<int32>

Minimum order quantity (supplier).

blockedForDelivery
number<decimal>

Quantity blocked for delivery.

reservedExternal
number<decimal>

Externally reserved quantity.

averagePurchasePrice
number<decimal>

Average purchase price.

lastPurchasePrice
number<decimal>

Last purchase price.

supplierPurchasePrice
number<decimal>

Purchase price from this supplier.

daysWithStock
integer<int32>

Number of days with stock.

consumptionXDaysWithoutPeaks
number<decimal>

Consumption over X days excluding order peaks.

averageOrderCount
number<decimal>

Average order count.

percentageSurcharge
number<decimal>

Percentage surcharge applied.

manualDemand
number<decimal>

Manual demand quantity.