pixiReport_ItemsOnStockWithBatchManagement

API call that exposes pixi* report: "Items on stock with BN/BBD"

Since pixi version: AVA 17.07 (8.4.31.30601) Additional notes: This report shows all items with TAGs for batch number or best before date that are currently on stock. It is possible to filter according to a certain time frame for best before date so that you can check which items on which bin places will expire soon. If you want to check the items with a specific batch number use the filter parameter for batch number. Filters for location and bin group allow to get a list of items for specific areas in your warehouse, TAG, category and supplier for a specific set of items.


Request

POST https://apigateway.descartes.com/tms/pixi/pixiReport_ItemsOnStockWithBatchManagement

Request body

Name Type Required Description
Ean string false

Search by barcode

Type: varchar(13)

Default value: Empty (all records shown)

Example: 12345fd343

Available from: AVA 17.07 (8.4.31.30601)

LocId string false

Search by Location ID

Type: varchar(3)

Default value: Empty (all records shown)

Example: 001

Available from: AVA 17.07 (8.4.31.30601)

ItemTag integer false

Search by Tag Key

Type: int

Default value: Empty (all records shown)

Example: -6 (Batch Number) or -7 (Best Before Date)

Available from: AVA 17.07 (8.4.31.30601)

BinGroup string false

Search by BinGroup

Type: varchar(20)

Default value: Empty (all records shown)

Example: sdfds223

Available from: AVA 17.07 (8.4.31.30601)

Category string false

Search by Category

Type: varchar(4)

Default value: Empty (all records shown)

Example: 123

Available from: AVA 17.07 (8.4.31.30601)

ItemNrInt string false

Search by Shop item number

Type: varchar(50)

Default value: Empty (all records shown)

Example: 123

Available from: AVA 17.12 (8.4.36.32642)

SupplierNr string false

Search by Supplier Nr.

Type: varchar(4)

Default value: Empty (all records shown)

Example: ABCD

Available from: AVA 17.07 (8.4.31.30601)

BatchNumber string false

Search by Batch number

Type: varchar(50)

Default value: Empty (all records shown)

Example: asdf1234

Available from: AVA 17.07 (8.4.31.30601)

BestBeforeDateTo string false

Search by Best Before Date - To

Type: datetime

Default value: End of current day

Example: YYYY-MM-DD hh:mm:ss

Available from: AVA 17.07 (8.4.31.30601)

BestBeforeDateFrom string false

Search by Best Before Date - From

Type: datetime

Default value: Start of current day

Example: YYYY-MM-DD hh:mm:ss

Available from: AVA 17.07 (8.4.31.30601)


Response

1. Report "Items on stock with BN/BBD" output columns

Name Type Description
EANUPC string

Item barcode

Type: varchar (13)

Available from: 25.06 (25.6.0.58802)

BinName string

Bin name where the item is located

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

ItemKey integer

pixi* item ID

Type: int

Available from: 25.06 (25.6.0.58802)

BinGroup string

Bin group

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)

ItemName string

Item name

Type: varchar (120)

Available from: 25.06 (25.6.0.58802)

QtyInBin integer

Item quantity in specified bin place

Type: int

Available from: 25.06 (25.6.0.58802)

ItemNrInt string

Shop item number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

BatchNumber string

Item batch number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

ItemNrSuppl string

Item number supplier

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

BestBeforeDate string

Item best before date

Type: datetime

Available from: 25.06 (25.6.0.58802)

2. Error response

Name Type Description
Status string

Status of the responce

Type: varchar(50)

Available from: 25.06 (25.6.0.58802)

Message string

Description of the error response

Type: varchar(4000)

Available from: 25.06 (25.6.0.58802)