Description
Create new purchase order for one supplier
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
AppName |
string |
1 |
Application name |
Name of application which execute API call |
| 2 |
UserId |
integer |
0 |
123 |
Id of user who execute API call |
| 3 |
UserName |
string |
1 |
API user |
User name of user who execute API call |
| 4 |
SupplierId |
integer |
0 |
123 |
SupplierId or SupplierNr must be provided; Supplier ID |
| 5 |
SupplierNr |
string |
0 |
MGS |
SupplierNr or SupplierId must be provided; Supplier number (code) |
| 6 |
DeliveryLocation |
string |
0 |
001 |
One of delivery location parameter must be provided; Id of shipping and billing location |
| 7 |
DeliveryLocationId |
integer |
0 |
123 |
One of delivery location parameter must be provided; Character code of shipping and billing location |
| 8 |
OrderLocation |
string |
0 |
001 |
One of order location parameter must be provided; Id of order location |
| 9 |
OrderLocationId |
integer |
0 |
123 |
One of order location parameter must be provided; Character code of order location |
| 10 |
SupplOrderDocument |
string |
1 |
check additional information |
Item XML see additional information tab |
| 11 |
ConsiderPackageUnits |
boolean |
0 |
0 or 1 |
Same functionality as at purchase order suggestions, apply (0 no, 1 yes) packing units |
| 12 |
ConsiderMinOrderQty |
boolean |
0 |
0 or 1 |
Same functionality as at purchase order suggestions, apply (0 no, 1 yes) minimum order quantity |
| 13 |
ExternalCode |
string |
0 |
abcd |
External code |
| 14 |
EstimatedDeliveryDate |
string |
0 |
date format: YYYYMMDD hh:mm:ss[.mmm] |
Estimated delivery date |
| 15 |
ShowDetailedReturn |
boolean |
0 |
0 or 1 |
Switch: Return detailed result |
| 16 |
Type |
integer |
0 |
1 or 2 |
Purchase order type (1 = Purchase Order, 2 = Pre-Order) |
| 17 |
OrderConsiderationStartDate |
string |
0 |
date format: YYYYMMDD hh:mm:ss[.mmm] |
Only applicable for Pre-Orders; Exclude from upcoming purchase order suggestions until this date |
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:pixiSupplierOrderCreate>
<dem:AppName>Application name</dem:AppName>
<dem:UserId>123</dem:UserId>
<dem:UserName>API user</dem:UserName>
<dem:SupplierId>123</dem:SupplierId>
<dem:SupplierNr>MGS</dem:SupplierNr>
<dem:DeliveryLocation>001</dem:DeliveryLocation>
<dem:DeliveryLocationId>123</dem:DeliveryLocationId>
<dem:OrderLocation>001</dem:OrderLocation>
<dem:OrderLocationId>123</dem:OrderLocationId>
<dem:SupplOrderDocument>check additional information</dem:SupplOrderDocument>
<dem:ConsiderPackageUnits>0 or 1</dem:ConsiderPackageUnits>
<dem:ConsiderMinOrderQty>0 or 1</dem:ConsiderMinOrderQty>
<dem:ExternalCode>abcd</dem:ExternalCode>
<dem:EstimatedDeliveryDate>date format: YYYYMMDD hh:mm:ss[.mmm]</dem:EstimatedDeliveryDate>
<dem:ShowDetailedReturn>0 or 1</dem:ShowDetailedReturn>
<dem:Type>1 or 2</dem:Type>
<dem:OrderConsiderationStartDate>date format: YYYYMMDD hh:mm:ss[.mmm]</dem:OrderConsiderationStartDate>
</dem:pixiSupplierOrderCreate>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: When a new purchase order gets created
| # |
Name |
Type |
Description |
| 1 |
SupplierOrderId |
integer |
Purchase order ID |
| 2 |
InternalNumber |
integer |
Purchase order internal number |
Body 2: Detailed result set
| # |
Name |
Type |
Description |
| 1 |
SupplierOrderId |
integer |
Purchase order ID (Example: 14599) |
| 2 |
InternalNumber |
integer |
Purchase order Nr (Example: 70014599) |
| 3 |
SupplierOrderlineId |
integer |
Purchase orderline ID |
| 4 |
ItemId |
integer |
Item ID |
| 5 |
ItemName |
string |
Item name |
| 6 |
ItemNrSuppl |
string |
Supplier item number |
| 7 |
ItemNrInt |
string |
Shop item number |
| 8 |
StatusMessage |
string |
(Item does not have the correct supplier assigned |ItemNrSuppl is missing for the item | Item not FOUND | OK) |
| 9 |
ItemCodeInternal |
string |
Internal item number |
Additional Notes
CAUTION: Only one item (per location) can be added per purchase order.
All separated rows will be combined together and summarized.
NOTE: It is best to use both tags (ItemNrSuppl,ItemNrInt) to ensure uniqueness of the added item.
**PurchaseOrderDocument** parameter sample XML:
<Items>
<Item>
<ItemNrInt></ItemNrInt>
<ItemNrSuppl></ItemNrSuppl>
<SupplierPrice></SupplierPrice>
<Qty></Qty>
</Item>
</Items>