pixi

Shipping

This page describes the exchange events published by pixi during warehouse processing and fulfillment activities, including ScanInPutIntoBox, PackageLabelSaved, PickEvents, ShipOutStarted, ScanInBoxFull, and ScanInBoxPhysicallyFull. Each event includes its exchange name, trigger conditions, payload fields, and a sample message.


Event Name

Exchange Name

ScanInPutIntoBox

pixiEXScanInPutIntoBox

The event happens, when an item is processed on Scan-In via:

  • pixi Mobile

  • pixi Desktop

  • pixi Web

  • API call pixiPutIntoBox

The message, which is sent to the exchange, contains the following information:

  • boxNumber: Shipping box number

  • userName: User who did the Scan-In

  • action: "Put Into Box"

  • boxDescription: Description of the box

  • OrderlineKey: Identifier for the orderline



Example:
{
"data":[
{

"boxNumber":12,
"userName":"admin",
"action": "Put Into Box",
"boxDescription": "2-1-1-5"
"OrderlineKey": "6258"

}
]
}

PackageLabelSaved

pixiEXPackageLabelSaved

The event happens, when an invoice package is updated using the API call pixiUpdateInvoicePackage.
It is needed for the Ship-Out - Multiple packages functionality in order to trigger printing of the shipping label once it was retrieved from an external source.

The message, which is sent to the exchange, contains the following information:

  • packageId: Unique package ID


Example:
{
"data":[
{

"BinKey":4404,
"BinName":"E-2-2",
"ItemKey":389,
"ItemNrInt":"2000039500005",
"Quantity":4,
"UserName":"admin",
"DeviceName":"Mobile1",
"ProgramName":"Picklist",
"PicklistNr":1813

}
]
}


PickEvents

pixiEXPickEvents

Functionality:

  • The first message is sent when a new picklist is opened in the Picklist or Pick to Box program.

  • The next message is sent when the item is confirmed or when a user switches to the next item.

  • If a partially processed picklist is reopened in the Picklist program, the message is sent only for the unprocessed items (items that weren't scanned before).

  • If a partially processed picklist (processed in program Picklist) is reopened in Pick to Box, the message is sent for all items (including the ones that were already scanned in).

  • The message is also sent when an item is scanned in Pick to Box, only the ProgramName in the message is different.

  • When database setting (Mobile) Picklist - Confirm quantity is enabled, the screen for confirming the item quantity is shown only when the item is scanned for the first time and the message is sent for the next item on the picklist.

  • When enabling pixiEXPickEvents, it takes approx. 30 minutes until the features can be used.

The message, which is sent to the exchange, contains the following information:

  • BinKey

  • BinName

  • ItemKey

  • ItemNrInt

  • Quantity (the pick qty)

  • UserName

  • Device Name (editable by the device admin)

  • ProgramName

  • PicklistNr

Example:
{
"data":[
{

"invoiceKey": 1234,
"invoiceNr": "PIX10000001",
"shipVendorCode": "DHL",
"boxNr": 10,
"stationId": 46,
"stationName": "PC-1",
"1SS": "Automatic",
"userName": "admin",
"shopId": "PIX",
"orderList": [
{
"orderNr": 140494,
"orderNrExternal": "P140494"
}

}
]
}

ShipOutStarted

pixiEXShipOutStarted

The message is sent when the messaging event is enabled (ON) and the Ship-Out functionality in pixi Web is used. In Multiple Packages, the message is sent only when the box or invoice number is scanned. Additionally, if 1-Scan-Shipping Automatic Ship-Out is ON, the message will be sent at Scan-In. But if 1-Scan-Shipping Automatic Ship-Out: OFF then the message will be sent only at ship-out. The message event for ShipOutStarted is not sent when an error ocurrs and when the Shipping client is used. This messaging event can be used together with the new API call pixiInvoicePackageLines that returns information about package and invoice details.

The message, which is sent to the exchange, contains the following information:

  • invoiceKey

  • boxNr Wird nur gesendet, wenn eine Box/Rechnung, die manuell oder automatisch erstellt wurde, eingescannt wurde.

  • stationId Die ID der Versandstation, durch die der Ship-Out initiiert wurde.

  • "1SS" Die Erstellmethode der Rechnung:

    • 1SS

    • Direct

    • Manual

    • Automatic

  • invoiceNr

  • ShipVendorCode

  • stationName

  • userName

  • shopId

  • orderList

    • orderNr

    • orderNrExternal

Example:
{
"data":[
{

"invoiceKey": 1234,
"invoiceNr": "PIX10000001",
"shipVendorCode": "DHL",
"boxNr": 10,
"stationId": 46,
"stationName": "PC-1",
"1SS": "Automatic",
"userName": "admin",
"shopId": "PIX",
"orderList": [
{
"orderNr": 140494,
"orderNrExternal": "P140494"
}

}
]
}

ScanInBoxFull

pixiEXScanInBoxFull

The event is sent as soon as a box is full, when the last item of the order has been scanned. The following parameters are sent:

  • boxKey

  • boxNumber

  • boxColor

  • locationCode

  • userName

  • customerId

  • orderNumber

  • orderNumberExternal

Examples:
Scan-In without Picklist

  • Order with one item: After the item has been scanned, the message is sent.

  • Order with multiple items: After the last item has been scanned, the message is sent.

  • Customers with multiple orders including one item in a box: After an item has been scanned, the message is sent.

Scan-in with 1SS Picklist:

  • No message is sent.

Scan-in with Picklist:

  • Order with one item: After the item has been scanned, the message is sent.

  • Order with multiple items: After the last item has been scanned, the message is sent

  • Customers with multiple orders including one item in a box: After an item has been scanned, the message is sent.


Example:
{
"data":[
{

"boxKey": 13728,
"boxNumber": 1,
"boxColor": "#FFFF00",
"locationCode": "001",
"userName": "admin",
"customerId": 1007,
"orderNumber": 142305,
"orderNumberExternal": "P142305"

}
]
}


ScanInBoxPhysicallyFull

pixiEXScanInBoxPhysicallyFull

The event is sent as soon as a box with the option "Box physically full" has been marked in pixi Mobile. The following parameters are sent:

  • boxKey: A unique identifier for the selected box.

  • boxNumber: The designated number or code associated with the selected box.

  • locationId: The physical location within the Stock where the event was triggered.

  • binName: The name of the bin from which the last item was picked

  • binSortNum: The sort number of the bin from which the last item was picked

  • userName: The name of the user who triggered the event by marking the box as full.


Example:
{
"data":[
{

"boxKey": 13728,
"boxNumber": 1,
"locationId": "001",
"binName": "A-1-1",
"binSortNum": 101,
"userName": "admin"

}
]
}


Back to top