Event Name

Exchange Name

InvoiceChanged

pixiEXInvoiceChanged

The event is triggered, when a customer invoice is updated by a Tracking-ID and|or by a Return-Tracking-ID.

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

• invoiceKey: Unique invoice identifier

• invoiceNr: Invoice number

• changeSource:

  • "empty" in case of general changes or

  • "SetTrackingId" if the invoice was changed by using API call pixiUpdateInvoicePackage

    • or via parsing through pixi Connector Tracking-ID Import functionality

    • ChangeSource: SetTrackingId for both cases

      • set only Tracking-ID or

      • set Tracking-ID and Return-Tracking-ID

• trackingID: Tracking number(s)

• returnTrackingId: Return-Tracking number(s)

• refToInvoiceKey: This value is provided if a return was created. If it is not provided, the message refers to an invoice.

Example:
{
    "data":[
        {  

						"invoiceKey": 1,

						"invoiceNr": "PIX000001",

						"changeSource": "SetTrackingId",

						"returnTrackingId": "0000011;"




        }
    ]
}

InvoiceCreated

pixiEXInvoiceCreated

The event is triggered when a new customer invoice or credit is created. The message, which is sent to the exchange, contains the following information:

• InvoiceKey: Unique invoice/credit identifier

• InvoiceNr: Invoice/credit number

• ShipVendorCode: Shipping vendor

• FullShippingAddress

  • salutation: Salutation

  • name: Full name

  • name2: Additional name field

  • firstName: First name

  • lastName: Last name

  • careOf: Care of / Company name

  • address: Complete address

  • street: Street name

  • houseNumber: House number

  • city: City

  • zip: ZIP/Postal code

  • Country: Country code

  • zipMb: ZIP Mailbox

  • mailbox: Mailbox

  • contact: Contact person

  • ansprache: Salutation (for backwards compatibility)

  • phone: Primary phone number

  • phone2: Secondary phone number

  • fax: Primary fax number

  • fax2: Secondary fax number

  • eMail: Primary email address

  • eMail2: Secondary email address

• TotalAmount

• ShipCosts

• PaymentCode

• BoxNr Note: Box number is populated only with regular order processing with picklist. In case of direct invoice or 1-Scan-Shipping, box number is empty.

• OrderNr

• OrderNrExternal

• refToInvoiceKey: This value is provided if a return was created. If it is not provided, the message refers to an invoice.

Example:
{
    "data":[
        {  

				"invoiceKey": 1,

        "invoiceNr": "PIX000001",

        "shipVendorCode": "DHL",

        "totalAmount": 30.75,

        "shipCosts": 0,

        "paymentCode": "N",

        "boxNr": 1,

        "orderNr": 12345,

        "orderNrExternal": "P12345",

        "fullShippingAddress": {

            "salutation": "Herr",

            "name": "Max Mustermann",

            "name2": "",

            "firstName": "Max",

            "lastName": "Mustermann",

            "careOf": "Musterfirma GmbH",

            "address": "Musterweg 1",

            "street": "Musterweg",

            "houseNumber": "1",

            "city": "Musterstadt",

            "zip": "12345",

            "Country": "DE",

            "zipMb": "",

            "mailbox": "",

            "contact": "",

            "ansprache": "",

            "phone": "+49 123 456789",

            "phone2": "",

            "fax": "",

            "fax2": "",

            "eMail": "max.mustermann@example.com",

            "eMail2": ""
						  }



        }
    ]
}

InvoiceDeleted

pixiEXInvoiceDeleted

The event is triggered when a customer invoice is deleted. The message, which is sent to the exchange, contains the following information:

• InvoiceKey: Unique invoice identifier

• InvoiceNr: Invoice number

• refToInvoiceKey: This value is provided if a return was created. If it is not provided, the message refers to an invoice.

Example:
{
    "data":[
        {  

						"invoiceKey": 1,

						"invoiceNr": "PIX000001"
						

        }
    ]
}

RequestPackageLabel

pixiEXRequestPackageLabel

The event is triggered when Ship-Out was done for an invoice or box or when a new label is printed via the "Reprint" button. Additionally, the option "Shipping Label" (pixi Control Center > Shipping Vendors table) needs to be set to "Use External Label" ("Pixi System Service" from 23.01) to trigger this event.
The message, which is sent to the exchange, contains the following information:

• invoiceKey: Unique invoice identifier

• invoiceNr: Invoice number

• shippingAddress: The address the order is shipped to

  • company

  • firstName

  • lastName

  • street

  • houseNr

  • city

  • zip

  • state

  • country: ISO2 country code

  • eMail

  • phone

• shipFromAddress: Address details of the location shipped from, where not NULL

  • name: company name

  • address

  • city

  • zip

  • country

  • eMail

  • phone

• shopAddress: The shop's address information

  • name

  • address

  • city

  • zip

  • state

  • country: ISO2 country code

  • eMail

  • phone

• packageInformation: Information about the package weight, currency, delivery and whether a return label is sent

  • packageId: Unique package identifier

  • grossWeight: Package gross weight

  • amount: Package total amount

  • currency: Package currency

  • cashOnDelivery: if package payment code is "N", then the value is 1, otherwise it is 0

  • printReturnLabel: 1 or 0, value from pixi Control Center > Shipping Vendors table > Print return label option

  • packageNumber: 1 or 0,

    • Single packages: 1 (always set to this value for single packages)

    • Multiple packages:

      • first package

        • "packageNumber": 1

      • last package

        • "packageNumber": X number of last package

  • packingComplete: false

    • Single packages: true

    • Multiple packages:

      • first package

        • "packingComplete": false

      • last package

        • "packingComplete": true if it is the last package and no more items to be shipped out

• packageTypeInformation: Information about the volume of the package

  • packageId: Unique package identifier

  • weight: Package gross weight * 1000

  • weightUnit: always contains "grams"

  • length: Used package types length from pixi Control Center > Package Types table

  • height: Used package types height from pixi Control Center > Package Types table

  • width: Used package types width from pixi Control Center > Package Types table

  • sizeUnit: Used package types dimensional unit from pixi Control Center > Package Types table

  • predefinedPackageDimensionCode: Used package types internal ID

• shipVendor: Shipping Carrier (DE: Versand über)

• externalShipmentId: ID at the external shipment provider associated with this package and its label

• orderNrExternal: External|shop order number (DE: Bestellnr. Shop)

• stationId: Workstation ID

• addressRemarks: Remarks from Addresses table (mostly to specify Shipping Addresses) (DE: Adresszusatz)

• transportRemarks: (siehe weiter unten: OPENTRANS Transport Remarks)

  • Method: Method provided by Shipping Carrier (DE: Verfahren)

  • Product: Product provided by Shipping Carrier (DE: Produkt)

  • Tools: Tools provided by Shipping Carrier (DE: Extras)

  • Shipping date: date set by customer or merchant to postpone a shipment until a specific data (FORMAT: "2021-01-01T00:00:00") (DE: Versanddatum)

• connectedChannelId: Channel that's connected to the packages ship vendor

• isMultiPackage: whether or not this is multipackage, to fetch line details via SOAP API Call

  • for only one/a single package:

    • for the first (only) package

      • isMultiPackage: false

  • for multiple packages

    • for the first package:

      • "isMultiPackage": true

    • for the second/last package of the invoice:

      • "isMultiPackage": true

    • for the invoice where only one package is created via multiple packages:

      • "isMultiPackage": false

Hinweis zu packageInformation: (Optional) Ist für den Logistiker der 1SS-Bestellung die Option ShipOut - Paketart erfragen aktiviert (bspw. für Amazon Seller Fulfilled Prime), muss die Paketart aus einer Dropdown-Liste ausgewählt werden. Die Paketart kann entweder durch Scan des Codes der Paketart oder manueller Auswahl im Dropdown festgelegt werden. Sind die Artikeldimensionen korrekt gepflegt, wird die Paketart von pixi automatisch ermittelt und verwendet.

Example:
{
    "data":[
        {  

						"invoiceKey": 137,

						"invoiceNr": " PIX000011",

						"shippingAddress": {

						  "firstName": "Max",

						  "lastName": "Mustermann",

						  "street": " Musterweg ",

						  "city": "Musterstadt",

						  "zip": "12345",

						  "country": "DE",

						  "eMail": "max.mustermann@pixi.eu",

						  "phone": "0123 4567890"

						},

						"shopAddress": {

						  "name": "shop.pixi.net",

						  "address": "Pixistraße 1",

						  "city": "München",

						  "zip": "80336",

						  "country": "DE",

						  "eMail": "support@pixi.eu",

						  "phone": "089/1234568"

						},

						"shipFromAddress": {

						  "name": "pixi",

						  "address": " Pixistraße 1",

						  "city": "München",

						  "zip": "80336”,

						  "country": "DE"

						},

						"packageInformation": {

						  "packageId": 108,

						  "grossWeight": 3,

						  "amount": 17.46,

						  "currency": "EUR",

						  "cashOnDelivery": "0",

						  "printReturnLabel": 0,

						  "packageNumber": 1,

						  "packingComplete": true

						},

						"packageTypeInformation": {

						  "packageId": 108,

						  "weight": 3000,

						  "weightUnit": "grams",

						  "predefinedPackageDimensionCodeAmazon": ""

						},

						"shipVendor": "DHL",

						"orderNrExternal": "P132",

						"stationId": "Station 1",

						"isMultiPackage": false

						}



        }
    ]
}

ReturnCreated

pixiEXReturnCreated

When enabled, a message is sent when a new return case is created in pixi mobile. It complements the existing ReturnStatusChanged messaging event which is published when for every status change of a return case. The ReturnCreated event on the other hand represents the creation of the return case.

• returnId

• invoiceKey

• invoiceNr

• returnStatusId: 1 (for NEW)

• returnStatus: New

Example

{

  "data": [

    {

      "returnId": 1083,

      "invoiceKey": 4659,

      "invoiceNr": "PIX1000001",

      "returnStatusId": 1,

      "returnStatus": "New"

    }

  ]

}

ReturnStatusChanged

pixiEXReturnStatusChanged

The event is triggered when the status of a return created in pixi Mobile changes. The message, which is sent to the exchange, contains the following information:

• ReturnId: Unique return identifier (in GUI shown as "RET+ID")

• InvoiceKey: Unique invoice identifier

• InvoiceNr: Invoice number

• ReturnStatusId: Unique return status ID

• ReturnStatus: Name of the new return status

Example:
{
    "data":[
        {  

						"returnId":1083,

						"invoiceKey":4659,

						"invoiceNr":"PIX1000001",

						"returnStatusId":3,

						"returnStatus":"Credited"


        }
    ]
}

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",


        }
    ]
}

Event Name

Exchange Name

OrderCreated

pixiEXOrderCreated

The event is triggered when a new customer order gets created. This event is triggered in the following scenarios:

• A new customer order is imported via pixi Order Import.

• A new customer order is imported via API call pixiImportAddXML.

• A new, empty customer order is manually created in pixi Customer Service application.

• An offer is set to "won" in pixi Web application and therefore it gets transformed into a customer order.

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

• OrderHeaderKey: Unique order number identifier

• OrderNr: pixi order number

Example:
{
    "data":[
        {  

						"orderHeaderKey":142247,

						"orderNr":142247


        }
    ]
}

PicklistCreated

pixiEXPicklistCreated

The event is triggered when a new picklist was created. It contains the following information:

• PicklistHeaderId: Picklist number

• LocationId

• FromBox

• ToBox

• OneScanShipping: 0 = normal picklist, 1 = 1SS picklist

• DaysBeforeBestBeforeDate: Number of days until the Best Before Date is reached

• Comment

• NumberOfOrdersOnPicklist: Number of orders included in this picklist

Example:
{
    "data":[
        {  

						"PicklistHeaderId":6296261,

						"LocationId":"001",

						"FromBox":0,

						"ToBox":0,

						"OneScanShipping":0,

						"DaysBeforeBestBeforeDate":0,

						"Comment":"Pickliste A",

						"NumberOfOrdersOnPicklist":1



        }
    ]
}

Event Name

Exchange Name

MailCreated

pixiEXMailCreated

The event is triggered when an e-mail was created. This event is triggered in the following scenarios:

• E-mails have been created automatically in pixi by an agent job.

• An e-mail has been created manually in pixi Customer Service.

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

• NrOfMailsCreated: Number of mails that have been created.

Example:
{
    "data":[
        {  

						"NumberOfMailsCreated":100



        }
    ]
}

Event Name

Exchange Name

ItemStockChanged

pixiEXItemStockChanged

The event is triggered 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.

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 is triggered 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.

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.

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}




        }
    ]
}

StockShortageReported

pixiEXStockShortageReported

The event is triggered 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 is triggered 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",





        }
    ]
}

Event Name

Exchange Name

POSInvoiceCreated

pixiEXPOSInvoiceCreated

The event is triggered when a new POS invoice is created. The message, which is sent to the exchange, contains the following information:

• POSheaderKey: Unique POS invoice identifier

• InvoiceNr: POS invoice number

Example:
{
    "data":[
        {  

						"POSheaderKey":611,

						"InvoiceNr":"2020-21-6"






        }
    ]
}

Event Name

Exchange Name

SupplierOrderChanged

pixiEXSupplierOrderChanged

The event is triggered when a supplier order is changed in pixi Web application or via API. The message, which is sent to the exchange, contains the following information:

• SupplierOrderKey: Unique supplier order identifier

• InternalNumber: Supplier order number

Example:
{
    "data":[
        {  

						"SupplierOrderKey":14913,

						"InternalNumber":70014913







        }
    ]
}

SupplierOrderCreated

pixiEXSupplierOrderCreated

The event is triggered when a new supplier order is created in pixi Web application or via API. The message, which is sent to the exchange, contains the following information:

• SupplierOrderKey: Unique supplier order identifier

• InternalNumber: Supplier order number

Example:
{
    "data":[
        {  

						"SupplierOrderKey":14913,

						"InternalNumber":70014913







        }
    ]
}

SupplierOrderStatusChanged

pixiEXSupplierOrderStatusChanged

The event is triggered when a supplier order status is changed in pixi Web application or via API. In this case, no message will be created for pixiEXSupplierOrderChanged exchange. The message, which is sent to the exchange, contains the following information:

• SupplierOrderKey: Unique supplier order identifier

• InternalNumber: Supplier order number

Example:
{
    "data":[
        {  

						"SupplierOrderKey":14913,

						"InternalNumber":70014913







        }
    ]
}

Event Name

Exchange Name

DeliveryStatusChanged

pixiEXDeliveryStatusChanged

The event is triggered when a delivery:

• is closed by pixi Mobile

• is closed or set to invoiced or re-opened in the pixi Web application

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

• DeliveryID: Unique delivery identifier

• DeliveryNumber: Delivery number

• DeliveryStatus: Delivery status (NEW, CLS or INV)

• DeliveryWasReopened

  • 0: The delivery was never re-opened.

  • 1: The delivery was re-opened at least once.

Example:
{
    "data":[
        {  

						"DeliveryID":162,

						"DeliveryNumber":1002688,

						"DeliveryStatus":"NEW",

						"DeliveryWasReopened":0








        }
    ]
}