Description
API call is used to create new supplier relationships for items. This call only performs INSERT operations. To modify existing supplier relationships, use pixiSetItemSupplier.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ItemKey |
integer |
0 |
364 |
Filter: pixi item ID. At least one of ItemKey, EAN or ItemNrInt must be provided. Matched via fpixi_GetItemIdentificationData as ItemId. |
2 |
ItemNrInt |
string |
0 |
2000040100003 |
Filter: Shop item number. At least one of ItemKey, EAN or ItemNrInt must be provided. Matched via fpixi_GetItemIdentificationData as code where CodeTypeId = 2. |
3 |
EAN |
string |
0 |
3184340004816 |
Filter: Item barcode. At least one of ItemKey, EAN or ItemNrInt must be provided. Matched via fpixi_GetItemIdentificationData as code where CodeTypeId = 1. If NewEAN is not provided, this value is also used as the EANUPC for the new record. |
4 |
NewEAN |
string |
0 |
4006381333931 |
Value: New EAN barcode to assign to the supplier relationship (EANUPC). Takes priority over EAN for the inserted EANUPC value. If neither is provided, EANUPC is read from the Items table. |
5 |
SupplNr |
string |
1 |
AB01 |
MANDATORY - Supplier number code. Must exist in the Suppliers table. |
6 |
SupplPrice |
number |
0 |
12.99 |
Value: Supplier price for the item. Default is 0. |
7 |
ItemNrSuppl |
string |
0 |
SUPPL-001 |
Value: Supplier item number. Inserted as AddItems.ItemNrSuppl. |
8 |
PreferredSupplier |
boolean |
0 |
1 |
Switch: When set to 1, all other suppliers for the item are reset to PreferredSupplier=0 before inserting. Default 0. |
9 |
MinOrderQty |
integer |
0 |
10 |
Value: Minimum order quantity for this supplier relationship. Default 0. |
10 |
OnlyPU |
boolean |
0 |
1 |
Switch: Order only by package units (OrderOnlyPackageUnits). Default 0. |
11 |
ItemDeliveryTime |
integer |
0 |
5 |
Value: Supplier delivery time in days (SupplDeliveryTime). Default 0. |
12 |
IsActive |
boolean |
0 |
1 |
Switch: Mark the new supplier item as active (1) or inactive (0). Default 1. |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiCreateItemSupplier>
<dem:ItemKey>364</dem:ItemKey>
<dem:ItemNrInt>2000040100003</dem:ItemNrInt>
<dem:EAN>3184340004816</dem:EAN>
<dem:NewEAN>4006381333931</dem:NewEAN>
<dem:SupplNr>AB01</dem:SupplNr>
<dem:SupplPrice>12.99</dem:SupplPrice>
<dem:ItemNrSuppl>SUPPL-001</dem:ItemNrSuppl>
<dem:PreferredSupplier>1</dem:PreferredSupplier>
<dem:MinOrderQty>10</dem:MinOrderQty>
<dem:OnlyPU>1</dem:OnlyPU>
<dem:ItemDeliveryTime>5</dem:ItemDeliveryTime>
<dem:IsActive>1</dem:IsActive>
</dem:pixiCreateItemSupplier>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Return message from the insert operation
# |
Name |
Type |
Description |
1 |
Status |
string |
Status of the return message. Possible values: Error, New record inserted. |
2 |
Message |
string |
Detail description of the return message. On success, contains the inserted SupplPrice, ItemNrSuppl and EAN values. |
Additional Notes
This call only performs INSERT operations. To modify an existing supplier relationship, use pixiSetItemSupplier.
The combination of SupplNr + EANUPC must be unique per item. If a record with the same supplier and EAN already exists for the item, the call returns an Error and no insert is performed.
When PreferredSupplier=1, all other existing supplier records for the item are reset to PreferredSupplier=0 before the new record is inserted.
If NewEAN is not provided but EAN is supplied, EAN is used as the EANUPC value for the new record. If neither is provided, EANUPC is read from the Items table.