Search

/rest/items?with=itemProperties&updatedBetween=2016-08-01&page=2

Getting Item data

/rest/items/{id}
/rest/items/{id}/variations/{variationId}
/rest/items/variations/
/rest/items/{id}/variations/{variationId}/variation_suppliers/
/rest/items/{id}/variations/{variationId}/variation_sales_prices/
/rest/items/{id}/variations/{variationId}/variation_barcodes/
/rest/items/{id}/variations/{variationId}/variation_categories/
/rest/items/{id}/variations/{variationId}/stock/
/rest/items/{id}/images/
/rest/items//barcodes/
/rest/categories
/rest/items/sales_prices
/rest/vat/
/rest/accounts/contacts
/rest/accounts/contacts/{customerId}
/rest/items/{id}/variations/{variationId}/variation_skus/
/rest/items/manufacturers
/rest/items/{id}/variations/{variationId}/images
/rest/items/{id}/variations/{variationId}/variation_bundles/

Getting Order data

/rest/orders
/rest/orders/{orderId}/items/serialNumbers
/rest/orders/?statusFrom=5&statusTo=5&with=addresses,relation&page=2
/rest/comments/order/{orderId}/
/rest/orders/shipping/Countries
/rest/orders/{orderId}/shipping/packages
/rest/accounts/contacts/{ContactId}/
/rest/orders/{orderId}/shipping/packages
/rest/orders/shipping/shipping_service_providers/
/rest/comments/order/{orderId}
/rest/payments/orders/{orderId}
/rest/payments/methods/
/rest/webstores/

Send Stock export data

/rest/stockmanagement/warehouses?with=storagelocations
/rest/stockmanagement/warehouses
/rest/items/{id}/variations/{variationId}/stock/correction

Send Order export data

/rest/orders/{orderId}/shipping/packages/{orderShippingPackageId}
/rest/orders/{orderId}/shipping/packages
/rest/orders/shipping/shipping_information/
/rest/orders/{orderId}/shipping/packages
/rest/orders/{orderId}/shipping/packages/{packageId}
/rest/orders/{orderId}

Channel Setting

Description

Example Value

StoreHouse_ID
[Item Export]

The value from this setting is used for the item export and will be used for the WarehouseID field.

1

PixiOrderLocation
[Item Export]

This is needed to export item stock to plenty.
It needs to be "0" in order to export stock and is used for the StorageLocation field on item export.

0

Shop Username

Access data forplentyONE

Username

Shop Password

Access data for plentyONE

Password

Shop API URL

URL to the Plenty 7 shop

PlentyOrderImportStatus
[Order Import]

Orders in plentyONE with the numerical value set with this setting will be imported to pixi. The default value is specified in plentyONE specification.

5

PlentyOrderImportStatusAfterImport
[Order Import]

Status of orders which were imported to pixi is set to this numerical value in plentyONE. The default value is specified in plentyONE specification.

5.1

ItemImport_OrderUnit
[Item Import]

0: The update of the Packing Unit is not allowed when an item is imported to pixi.
Note: With the value being set to 0 or empty, if an item does not exist in pixi, Packing Unit will be set to 1.

1: The update of the Packing Unit is allowed when an item is imported to pixi.

1

ItemImport_MinOrderQty
[Item Import]

0: The update of the Minimum Order Quantity is not allowed when an item is imported to pixi.

1: The update of the Minimum Order Quantity is allowed when an item is imported to pixi.

1

Free1 as SerialNrReq
[Item Import]

0: <Free1> field in the XML is ignored

1: <Free1> field in the XML is used for importing the Serial Number Required flag. Serial Number Required flag is set for the item if the value of <Free1> = 1, otherwise the item is imported without the Serial Number Required flag.

1

ItemImport_PlentyGrossPriceId
[Item Import]

0: Sales price is not imported into pixi

1 (default): Item's sales price gets imported

1

AUS
[Order Export]

The value that represents the AUS status in plentyONE.

7.0

STO
[Order Export]

The value that represents the STO status in plentyONE.

8.0

NLB
[Order Export]

The value that represents the NLB status in plentyONE.

8.0

RET
[Order Export]

The value that represents the RET status in plentyONE.

9.0

PlentyItemsVAT0
[Item Import]

If the value for <VATInternalID> in the XML file = 0, the matching VAT rate in pixi is set in the fields

possible values: MwSt_High, MwSt_Low or MwSt_None

MwSt_High

PlentyItemsVAT1
[Item Import]

If the value for <VATInternalID> in the XML file = 0, the matching VAT rate in pixi is set in the fields

possible values: MwSt_High, MwSt_Low or MwSt_None

NULL

PlentyItemsVAT2
[Item Import]

If the value for <VATInternalID> in the XML file = 0, the matching VAT rate in pixi is set in the fields

possible values: MwSt_High, MwSt_Low or MwSt_None

NULL

PlentyItemsVAT3
[Item Import]

If the value for <VATInternalID> in the XML file = 0, the matching VAT rate in pixi is set in the fields

possible values: MwSt_High, MwSt_Low or MwSt_None

NULL

PlentyCustomerNrExternal
[Order Import]

CustomerNrExternal: billing e-mail address from the XML is imported and matched with the CustomerNr field in pixi. When the PlentyCustomerNrExternal channel setting is set to CustomerNrExternal, the system does not check for CustomerID values, allowing Plenty 7 customers to import orders without a Customer ID.

PlentyID: CustomerID from the XML (<Order><PlentyId>) is imported and matched with the CustomerNr field in pixi. Customer ID is only mandatory for import when the channel setting is set to "PlentyID".

PlentyOrderNumber: If the channel setting is set to PlentyOrderNumber, the order is imported with a prefix PON_ and the PlentyOrderId (pixi OrderNrExternal) as CustomerNrExternal (e.g. PON_355).

CustomerNrExternal

PlentyLastItemImportDate
[Item Import]

Date of last import job is saved to this field automatically

2018-01-01

PlentyLastSupplierImportDate
[Item Import]

Date of the last supplier import is saved to this field automatically

2018-01-01

InternalItemNumber
[Order Import]
[Item Import]

0: use ItemID

ItemID (default): use Variation Id from Plenty 7 shop (Id tag from variant)

ItemNo: use Variation No from Plenty 7 shop (Number tag from variant)

ItemNo

Item name suffix formula
[Item Import]

Empty: No suffix is added to the item name.

" PU: {{Variation.UnitsContained}}": The packing unit is added to the item name on item import.
"Item Name PU: 5"

" PU: {{Variation.UnitsContained}}"

PlentyCategoryUseNameHierarchy
[Item Import]

0: import only LEAF category name (e.g. Notebooks)

1: import FULL PATH category hierarchy (e.g. General > Computer > Notebooks)

2: import only TRUNK category name (e.g. General)

0

Use Item Name from Plenty Order
[Order Import]

0: orderline name will be taken from pixi

1: orderline name will be taken from the plenty orderline (<OrderItems><OrderItemName>)

0

Order Shop ID
[Order Import]

0: takes "ShopID" from channel matching table

1: takes "Referrer" from channel matching table

Referrer;MultiShop: takes "Referrer;MultiShop" from channel matching table

0

Multiply order qty with order unit
[Order Import]

0: no multiplication is done

1 (Default): Orderline Quantity = Orderline Quantity x Order Unit;
Orderline Price = (Order Total - Ship Cost) / Orderline Quantity

1

Plenty Package ID for Tracking ID Export
[Order Export]

1 (Default): Tracking ID is included in the ShippingTrackingId field in the order export XML

not 1: No tracking ID gets exported

1

B2B Customer Classes IDs
[Order Import]

This setting contains a list of customer classes IDs from plenty 7. The values are important to determine the order type for the customer order. In case the customers class matches what was entered in this setting, the order type will be "B2B".

121545,45789

Use Variation No. as Suppl. Item Nr. for Variants
[Item Import]

0 (Default): the Variation Nr. is not used as supplier item number for any item (normal or variant item) in pixi

1: On item import, the item variant's Variation Nr. from plenty is used as the supplier item number in pixi.
For normal items, the Supplier item No. from plenty is used as supplier item number in pixi.

Note: The customs tariff number of the (item) variant has priority over the customs tariff number of the main item.
From plentyONE (2019), the customs tariff number for variants can only be set in the plentyONE settings. For items that existed before 2019, it can also be set on the main item.
To remove the customs tariff number from a variant, a blank space must be entered as the value in the settings.
If the value is deleted entirely in plentyONE, pixi will still keep the old number.

0

Support Split Orders
[Order Import]

This setting controls the import of “Split orders” from plentyONE into pixi.

0: (default) If set to “0”, then all order types (e.g. Sales order [TypeId=1], Delivery order(s) [TypeId=2]) are imported (functionality previous to pixi 19.04).

1: If set to “1” and a Sales order (TypeId=1) was split into Delivery order(s) (TypeId=2) in plentyONE, then only the Delivery orders are imported - the Sales order (parent) is not.

0

Revert outgoing stock
[Order Export]

This setting affects the behavior of the “Outgoing items cancelled” item movement in plenty.

0: (default) The "Outgoing items cancelled" item movement is not triggered in plenty. Item stock is not increased after the order was marked as shipped.

1: The "Outgoing items cancelled" item movement is triggered in plenty. Item stock is increased after the order was marked as shipped.

0

Set Customer Lock for Orders with Shop Note
[Order Import]

This setting triggers customer lock, if set accordingly.

0: Customer lock is not set, in case an order was imported with shop note.

1: (default) Customer lock is set, in case the order was imported with shop note.

1

Import Item Status
[Item Import]

0: (default) only active items are imported from Plenty with status active

1: item status from plenty is updated in pixi.
This is achieved through also importing inactive items from Plenty and setting the item status for all imported items in pixi to that from Plenty.

Note: It is currently not possible to import inactive items without also updating the item status in pixi.

Export Item Status
[Item Export]

0: item status change in pixi not pushed to plentyONE

1: item status change in pixi pushed to plentyONE as well

Run Stock Export after Order Export
[Order Export]

0: Item stock is not exported after order export

1: (default) Item stock is exported after order export to correct stock in Plenty

Important: If this setting is enabled, then Revert outgoing stock needs to be disabled (0)

1

Export Bundle Items
[Item Export]

0: (default) pixi does not export bundle stock to plentyONE

1: pixi exports the available stock for bundles to plentyONE as physical stock; this only works in case the bundle in pixi is a normal item in plentyONE - otherwise plentyONE returns an error

0

Import Warranty Orders
[Order Import]

When both the Import Warranty Orders and the Support Split Orders channel settings are enabled, warranty orders are imported together with sales and delivery orders.

1

ItemExport_ExportOnlyPhysicalStockChanges
[Item

Only changed articles are exported (URL channel).

Manual export works independently of this setting.

0

XML field name

Name

Description

Examples

TypeId if it is "1"

LocationID

The value for the LocationID should be added to the matching table with the corresponding Location value in pixi Control Center > Locations table.

External system value: 1
Pixi value: 001

ReferrerId

ShopID

The value for the ShopID should be added to the matching table with the corresponding Shop ID value in pixi Control Center > Shops table.

Check the channel setting Order Shop ID for more information.

External system value: 4.01
Pixi value: MAD

TypeId if it is "3"

Payment

The value for the Payment should be added to the matching table with the corresponding Code value in pixi Control Center > Payment Types table.

External system value: 9
Pixi value: P
(PayPal in this case)

TypeId if it is "2"

ShipVendor

The value for the ShipVendor should be added to the matching table with the corresponding Vendor Code value in pixi Control Center > Shipping Vendors table.

External system value: 6
Pixi value: DHL

TypeId if it is "2"

ShipInstruct

If the setting Don't hard code DHL transport remark on import (Control Center > Database Settings > Import / Export > Order Import (Opentrans)) is set to ON, the ShipInstruct values are read from the matching table. The pixi value must be entered in the format Method|Product|Tools (for example, 53|5302|5311).

If this setting is OFF, the values in pixi are hardcoded and depend on the country of the delivery address and payment type:

External system value: 6
Pixi value: 53|5302|5311

In this case the order will be imported with the following information:

• Shipping vendor: DHL

• Method: 53

• Product: 5302

• Tools: 5311

ReferrerId

Referrer

The value for the Referrer should be added to the matching table with the corresponding Shop ID value in pixi Control Center > Shops table.

Check the channel setting Order Shop ID for more information.

External system value: 104.01
Pixi value: AKM

ReferrerId

Referrer;Multishop;

The value for the Referrer;Multishop; should be added to the matching table with the corresponding Shop ID value in pixi Control Center > Shops table.

Check the channel setting Order Shop ID for more information.

External system value: 4.04
Pixi value: FBA

Setting

Description

Folder General > Number of decimal places for prices

The number of decimal places used for rounding for prices. The default value is 2 decimal places.

Folder General > Show Item Nr. Suppl. from MGS supplier

If set to ON, the item number supplier from MGS supplier (if exists) is always displayed for the item.
If set to OFF, the item number supplier from the last supplier update is displayed for the item.

Folder Import/Export > Folder OpenTRANS > Don't hard code DHL transport remark on import

Enable this setting if you wish to import custom made DHL transport remarks from shop trough order import XML.

Folder Import/Export > Folder BMEcat > DF-Type - Default Value

This setting defines the default value of the direct fulfillment type of an order line if the order import XML does not contain any value.