Pixi API documentation

Sets the comment field `CHisNote` of a customer identified by its external customer number and returns 1 on success or 0 if no customer was found.

Returns pairs of potentially duplicate customer addresses from the duplicate check, with address, order, invoice and customer details for both sides.

Marks a stored pair of potential duplicate customers as used by setting `UsedFlag` = 1 in the duplicates list.

Finds probable duplicate customers by fuzzy address matching in batches of 2500 addresses and stores scored customer pairs in Addresses_Duplicates.

Returns all customer account events (bookings, including deleted ones) of a customer together with the customer's account statistics such as balance and suggested refund.

Updates the invoice due days and reminder (dunning) settings of one customer identified by CustKey or by external customer number/email plus shop.

Returns customs data (tariff number, country of origin, weight, dimensions) of one item, identified by item key, internal item number or EAN/UPC.

Returns items that are not yet tagged with the system tag `AtlasData`, including master data and customs fields, paged by `ItemKey`.

Updates the customs data (tariff number, country of origin, tariff text, previous procedure) and the weight and dimensions of an item.

Creates direct fulfilment (DF) invoices for order lines that are ready, optionally restricted to and enriched with ship vendor and tracking data from XML.

Returns the latest not yet notified fulfilment status changes of `FUT` order lines for a Direct Fulfillment supplier, with address, item and order data.

Confirms a processed order history change for a direct fulfillment supplier by setting its ClientNotified flag and, optionally, the tracking sent date of an invoice.

Returns the open direct fulfillment order lines (status FUT) of one order for a direct fulfillment supplier, authenticated by supplier number and secret.

Returns the direct-fulfillment (FUT) orderlines of one order for an authorized drop-shipping supplier, including item, status history and currency data.

Returns the order headers with shipping address data of orders that have open direct fulfillment order lines (status FUT) for a supplier.

Returns the users logged in to licence-relevant Pixi clients at a given snapshot time, or at the latest snapshot if no date is passed.

Checks a Pixi user name and password, optionally a permission code, and returns whether the login is valid together with the user's e-mail and real name.

Returns the latest version and the minimum allowed version of one or all Pixi client applications.

Returns one country or all countries from the Pixi country master data, optionally only countries that are used in addresses.

Returns the parent currencies from the Pixi currency code table, optionally filtered by ISO code or currency ID.

Returns the version of the current Pixi database, its revision name, the consistency status with the master database and endpoint information.

Creates a direct invoice for an order, either for all open orderlines or for a comma-separated list of orderline keys.

Creates a direct invoice (Rechnung) for an order, either for selected order lines or for all open lines, and returns the result as a status row.

Creates an invoice for a packed box (BoxNr at a location) and returns the new invoice ID and number together with a status row.

Creates a new POS invoice, or adds lines to an open one, from an XML document and books the sold items out of stock.

Returns POS sales and POS payments of a date range as DATEV booking lines (revenue per VAT rate and payment entries) for export to accounting.

Deletes a shipping package and its package lines from an invoice and updates the invoice's tracking IDs and package count.

Checks whether an item can be converted to or from a bundle and returns its key data together with a `CanConvert` flag.

Creates a new supplier assignment (AddItems record) for an existing item, optionally with its own EAN and as preferred supplier.

Deletes the supplier assignment (AddItems record) of an Artikel for a given Lieferant, provided no open supplier orders exist for it.

Returns a batch of items with preferred supplier, prices, stock and location-specific planning data for export to the Logcontrol Dispo software.

Returns all item categories with their ID and description, sorted by description.

Returns the item categories (table TontrArten), optionally filtered by key, short code or text.

Returns dashboard counts of shipped invoices for the given day, the previous day, the current month up to the end date and the previous month.

Returns the average order throughput time in days and the percentage of orders shipped within 24 hours for the last N days.

Adds a new order line for an item to an existing order, calculates prices and discounts, and returns the new order line ID or validation errors.

Splits (breaks) an order line into two lines by moving a given quantity into a new order line, optionally with a new status.

Checks whether new order lines may still be added to an order, based on the payment type and the status of its existing order lines.

Checks whether an order line can still be cancelled and returns 1 (yes) or 0 (no).

Returns the status of an order line and a flag that tells whether the order line can still be cancelled.

Cancels all open order lines of an order by setting their status to `STO` (cancelled) or `NLB` (not deliverable).

Sets the shop note (`Shop_Note`) of an order identified by its order number and returns 1 on success or 0 if the order is missing or masked.

Returns 1 if the address of an order may still be changed because no invoice lines exist for its order lines, otherwise 0.

Checks whether two orders can be merged and returns a flag and a reason code with text.

Changes the billing or shipping address of an order, as long as the order has not been invoiced yet.

Adds a free-text comment to an existing order and records the user and timestamp of its creation.

Deletes a complete order (Auftrag) if all orderlines are in status ANG, HAL or STO and none is on an active pick list.

Automatically matches the bank lines of a bank header to open orders or invoices, confirms the match and releases the order if it is fully paid.

Returns the number of bank lines that match the given bank texts and, optionally, the amount.

Creates a manual booking event in a customer's account and optionally matches it to an existing account entry or invoice.

Deletes a customer account event (CustomerAccount entry) together with its invoice, bank matches and account matches, if deletion is allowed.

Deletes all customer account matches of a customer account entry (CAref), including the bank matches derived from them.

Returns customer account events (bookings), filtered by event type, dates, amounts, invoice, payment method or customer, optionally including deleted events.

Creates a replacement order with negative quantities for selected order lines, based on the customer and addresses of an existing order.

Creates a replacement order for one or more return case lines, logs the request in the return case history and returns the new order number.

Returns the POS (point of sale) sales lines of a date range, optionally limited to one location, with item, supplier and price data.

Returns the quantity sold of one item per invoice month and year, optionally restricted to one shop.

Returns monthly package statistics from invoices for billing: total packages, single-item packages and packages flagged as 1SS, with size classes.

Returns the users currently logged in to Pixi that count against licences, optionally including mobile sessions.

Returns invoiced item lines with customer, country, net line total, currency and last sale date, filtered by item, shop, payment type, customer and invoice date.

Returns the order lines that can be shipped from current stock, either as line details or as totals (orders, value, shipping cost, picks), optionally per location.

Adds a line for an invoice line to an existing return case, or creates a new empty return case if no return case ID is passed.

Creates a return credit note for selected lines of an invoice, sets the order lines to returned and books the credit to the customer account.

Creates a new return case with status NEW and returns its ID and return number.

Returns items whose most frequent return reason occurs more often than a given threshold, together with that reason and its count.

Returns the lines of a return case with item, invoice line, bin location and translated reason and quality classification.

Returns a paged list of returns (Retouren) modified within a date range, optionally filtered by status and invoice number, including the related credit note.

Checks whether a pick list number exists and has not expired, and returns its box range, 1SS flag, scan state and number of open orders.

Creates a package (pixi.InvoicePackage) for an invoice, optionally with package lines, tracking IDs and label URLs, and returns the new PackageId.

Creates a picklist from a picklist profile, either directly or by adding the creation job to the execution queue.

Returns the items packed into a box, identified by box number and location, with order, orderline, item and scan data.

Returns the shipping packages of an invoice (labels, tracking IDs, weight, dimensions), selected by invoice number, invoice ID or package ID.

Returns shipped orders (based on invoices) for a date range per location, either as detail rows or as order count and total per location and currency.

Returns the peak number of concurrent licensed users (CULs) per hour or per day since a start date, broken down by Pixi client application.

Returns a monthly federal statistics (Intrastat-style) report of delivered supplier items, grouped by supplier country, customs tariff number and country of origin.

Returns, per day, the pixi* client applications that were open at the snapshot with the most connected users, or only the list of applications used.

Returns sales statistics for one item: quantities sold in the last 30/120/365 days, open and held quantities, open single-item orders and the ABC class.

Assigns a set of boxes to a picklist, replacing the previous box assignment, after checking that all boxes exist and that there are enough for the orders.

Creates one or more bins (Lagerplätze) from an XML list, validates each entry and returns a status row per bin.

Updates one or more existing bins (Lagerplatz) from an XML list and returns a status row for each bin.

Returns aggregated stock movements from the bin item log for an external disposition software (LogControl), optionally summed up per item in inventory mode.

Returns all items with a positive exportable stock for one location or all locations, together with item numbers, EAN, name, manufacturer, prices and category.

Returns all items changed since a given point in time with their available stock and the earliest expected delivery date from open supplier orders.

Creates a supplier delivery (goods receipt) with status NEW, either from a confirmed purchase order or from item lines passed as XML.

Adds a new item line to an open supplier delivery, identified by delivery key or number, and returns the created delivery line.

Creates a new supplier delivery (status NEW) from one or more confirmed supplier orders and then runs a delivery header list query.

Creates a new supplier delivery (status NEW) at a location from one or more confirmed supplier orders and returns its header.

Creates a new supplier together with its main contact and returns a status row with ReturnCode and Message.

Creates supplier (purchase) orders from a stored supplier order suggestion profile and returns the numbers of the created orders.