pixi
Ask AI
What's an 'Ideas Portal'?
API
DE

Items

This page describes the exchange events published by pixi for inventory and warehouse operations, including ItemStockChanged, ItemStockChangedExtended, StockShortageReported, ReturnLineToPrint, and StockMovement. Each event includes its exchange name, trigger conditions, payload fields, and a sample message.


Event Name

Exchange Name

ItemStockChanged

pixiEXItemStockChanged

The event happens, when the stock of an item changes. It is not triggered, in case of full item export. The message, which is sent to the exchange, contains the following information:

  • ItemKey: Unique item identifier

  • ItemNrInt: Items shop item number

If stock for more than one item was changed, the message contains an array of multiple items.

Note: Stock export needs to be up and running for the event to work properly. In case it takes too long, directly get the stock using pixiGetItemsStockHistory API call.


Example:
{
    "data":[
        {  

						"itemKey":583795,

						"itemNrInt":"PIX5587020"




        }
    ]
}


ItemStockChangedExtended

pixiEXItemStockChangedExtended

The event happens, when the stock of an item changes. It is not triggered, in case of full item export. The message, which is sent to the exchange, contains the following information:

  • ItemKey: Unique item identifier

  • ItemNrInt: Items shop item number

  • AvailableStock: Item's available stock; listed separately for every location (also special stock locations); total stock returned in "All"

  • PhysicalStock: Item's physical stock; listed separately for every location (also special stock locations); total stock returned in "All"

If stock for more than one item was changed, the message contains an array of multiple items.

Example:
{
    "data":[
        {  

							 "itemKey":1170,

							 "itemNrInt":"1SS109520POSbundle",

							 "availableStock": {"001":0, "002":0, "003":0, "004":0, "005":0, "006":0, "All":5, "REP":0},

							 "physicalStock": {"001":0, "002":0, "003":0, "004":0, "005":0, "006":0, "All":5, "REP":0}




        }
    ]
}

Notes:
- This event is disabled by default and needs to be enabled so it can be used. If item stock changes "ItemStockChanged" is used by default.
- Stock export needs to be up and running for the event to work properly. In case it takes too long, directly get the stock using pixiGetItemsStockHistory API call.


StockShortageReported

pixiEXStockShortageReported

The event happens, when a shortage was reported by a user in pixi Mobile programs Replenishment, Picklist or Pick-to-Box. The message, which is sent to the exchange, contains the following information:

  • binName: Bin the shortage was reported for

  • itemName

  • itemBarcode

  • picklistNumber: Contains the picklist number where the shortage was reported.
    Before, it was empty.

  • reportedByUser: User that reported the shortage


Example:
{
    "data":[
        {  

							"binName":"1-01-01",

							"itemName":"SampleItem",

							"itemBarcode":"9876543211234",

							"picklistNumber":6296572,

							"reportedByUser":"admin",

							"replenishmentId":null,

							"reportedOn":"2025-07-21T07:30:31.790"





        }
    ]
}

ReturnLineToPrint

pixiReturnLineToPrint

The event happens, when an item was put to stock with the option "Print item label" being enabled in pixi Mobile Program Returns.
The message, which is sent to the exchange, contains the following information:

  • itemKey: Unique item identifier

  • shopItemNumber

  • itemBarcode

  • itemName

  • quantity: Quantity of returned items

  • userName: User that is logged into pixi Mobile


Example:
{
    "data":[
        {  

						 "itemKey":339,

						 "shopItemNumber":"3438989832432jkjlkjd313",

						 "itemBarcode":"3184340000856",

						 "itemName":"Fluxkompensator",

						 "quantity":"1",

						 "userName":"pixidem",





        }
    ]
}

StockMovement

pixiEXStockMovement

This event is triggered when there is a stock movement of an item. In this case, a message is sent to the “pixiEXItemStockMovement” exchange. This event is deactivated by default. Please contact support if you would like to use it.

  • Stock movement message or for all Items marked with changed quantity

    • IBILKey

    • LocId - LocationId

    • BinName

    • Qty

    • ItemID

    • ItemNrInt

    • EANUPC

    • ItemNrSuppl

    • UpdateEmp

    • UpdateDate

    • Reason

    • SMType

    • SMOperation

    • RelocateTransactionID

Example:
{
    "data":[
        {  

            "IBILkey": 120480,
            "LocID": "001",
            "BinName": "111",
            "Qty": 30,
            "ItemID": 366,
            "ItemNrInt": "2000040300007",
            "EANUPC": "3184340004809",
            "ItemNrSuppl": "1367749208",
            "UpdateEmp": "admin",
            "UpdateDate": "Jul 25 2024  9:13AM",
            "Reason": "",
            "SMType": "0200",
            "SMOperation": "BinClient_A/PutoStock",
            "RelocateTransactionID": "91E1F8DF-E8AD- 40FA-14576A7841",


        }
    ]
}


Back to top