pixi Developer & Integration Documentation

pixiGetSupplierOrder

Description

API call retrieves purchase orders with purchase orderlines.


Request Parameters

#

Name

Type

Required

Example

Description

1

SupplNr

string

0

MGS

Supplier number (code)

2

SupplOrderNr

integer

0

123

Purchase order internal number

3

DateFrom

string

0

YYYY-MM-DD hh:mm:ss

Shows all Orderlines from that given Date on

4

DateTo

string

0

YYYY-MM-DD hh:mm:ss

Date range end

5

Status

string

0

NEW, BES, CON, CLS,

Purchase order status

6

RowCount

integer

0

1000

Define how many rows you want to get back max. Default: 1000. Important: if this parameter is included in the SOAP call, a value must be provided. Passing an empty value overrides the default and returns no results. Omit the parameter entirely if you do not want to limit the row count.

7

Start

integer

0

123

Start at row


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:pixiGetSupplierOrder>
         <dem:SupplNr>MGS</dem:SupplNr>
         <dem:SupplOrderNr>123</dem:SupplOrderNr>
         <dem:DateFrom>YYYY-MM-DD hh:mm:ss</dem:DateFrom>
         <dem:DateTo>YYYY-MM-DD hh:mm:ss</dem:DateTo>
         <dem:Status>NEW, BES, CON, CLS,</dem:Status>
         <dem:RowCount>123</dem:RowCount>
         <dem:Start>123</dem:Start>
      </dem:pixiGetSupplierOrder>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Purchase order result

#

Name

Type

Description

1

RowNr

string

Start row number

2

SupplierOrderlineKey

integer

Purchase orderline key

3

SupplierOrderNR

integer

Purchase order internal number

4

SupplierOrderNRExternal

string

External order number

5

OrderDate

string

Order create date

6

SupplNr

string

Supplier number (code)

7

Status

string

Purchase order status

8

EstimatedDelivery

string

Estimated delivery date

9

Note

string

Special note

10

EANUPC

string

Item barcode(EAN)

11

ItemNrSuppl

string

Supplier item number

12

OrderQty

integer

Ordered quantity

13

VPE

integer

Package unit

14

ItemName

string

Item name

15

SupplierOrderUpdateDate

string

Purchase order update date

16

SupplierOrderUpdateUser

string

Username of the last user that updated purchase order

17

SupplierOrderlineUpdateDate

string

Purchase orderline update date

18

SupplierOrderLineUpateUser

string

Username of the last user that updated purchase orderline

19

ItemKey

integer

Item ID

20

SupplPrice

number

Supplier price of the item

21

OrderedQty

integer

Ordered quantity

22

UndeliveredQty

integer

Not delivered quantity

23

DeliveredQty

integer

Delivered quantity

24

SupplierOrderType

string

Purchase order type (1= Purchase Order, 2=Pre-Order)

25

ItemNrInt

string

Shop item number

26

ItemCodeInternal

string

Internal item Number

27

DeliveryLocation

string

Delivery Location Id

28

ExtOrderNr

string

External Order Number

29

SupplierOrderId

integer

Supplier Order Id

30

SupplierOrderlineId

integer

Supplier Orderline Id

31

SupplierOrderCreateDate

string

Record create Purchase Order date

32

SupplierOrderCreateUser

string

User who created Purchase Order


Additional Notes

**NEW|NEU:** NEW is the initial status of a purchase order after its creation.
**BES|ORD:** Purchase order status **Ordered** (BES) is used when you send the purchase orders to the supplier. In this status, you can still add, update or remove items.
**CON|BGT:** Once the purchase order status is set to **Confirmed** (CON) by the supplier you cannot change add, update or remove items.
**CLS|ABG:** Purchase order status **Closed** (CLS) is used when the goods receipt for this purchase order was done and all items were delivered or marked as not delivered.
Status parameter must include only one of this statuses: NEW, BES, CON, CLS.
Datetime parameters will only include the date. Hours, minutes and seconds are ignored.