Recommended

API call returns item information.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Select multiple items with one call:

     When using **ItemXML** parameter one can get the item info for **multiple items** with one call.
     Sample XML structure:
    
         <ITEMS>
        	<ITEM><ITEMKEY>365</ITEMKEY></ITEM>
        	<ITEM><EAN>2000000000091</EAN></ITEM>
        	<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
        	<ITEM><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>
            <ITEM><INTERNALITEMNUMBER>123456abcdefg</INTERNALITEMNUMBER></ITEM>
        </ITEMS>
    
    ----------
    
    **Return data from item favourite supplier:**
    
    If parameter **ConsiderFavouriteSupplier** is set to **1** then values for 
    
     - EAN
     - ItemNrInt
     - ItemNrSuppl
     - SupplNr
     - SupplPrice
     - MinOrderQty (if the value is not explicitly set, 0 will be returned)
    
    will be taken from the item record flagged with **PreferredSupplier = 1**.
    In case there is no record for the item marked with PreferredSupplier flag, the values from the **default** item record will be returned.

Request

POST https://apigateway.descartes.com/tms/pixi/pixiGetItemInfo

Request body

Name Type Required Description
LocID string false

Filter: Location ID/code

Type: varchar(3)

Default value: NULL

Example: 001

Available from: LOU Official (6.3.0.4452)

EANUPC string false

Filter: Item barcode

Type: varchar(13)

Default value: NULL

Example: 123abc

Available from: LOU Official (6.3.0.4452)

ItemKey integer false

Filter: pixi* Item ID

Type: int

Default value: NULL

Example: 123456

Available from: LOU Official (6.3.0.4452)

ItemXML string false

Filter: XML with multiple defined filters.

Type: varchar(-1)

Default value: NULL

Example: See additional information

Available from: LOU Official - Update 46 (6.9.46.27927)

ItemNrInt string false

Filter: Shop item number

Type: varchar(50)

Default value: NULL

Example: 123abc

Available from: LOU Official (6.3.0.4452)

ItemNrSuppl string false

Filter: Item number supplier

Type: varchar(50)

Default value: NULL

Example: 123abc

Available from: LOU Official (6.3.0.4452)

InternalItemNumber string false

Filter: pixi* Internal item number

Type: varchar(50)

Default value: NULL

Example: asdf

Available from: AVA Official - Update 23 (8.4.23.27873)

ConsiderFavouriteSupplier boolean false

Switch: Return data connected to preferred/favourite supplier

Type: bit

Default value: 0

Example: 1

Available from: AVA 17.09 (8.4.33.31482)


Response

1. Returning the item information.

Name Type Description
ABC string

Item system tag

Type: char

Available from: / (25.7.0.59144)

VPE string

Packing unit (LOU version)

Type: smallint

Available from: / (25.7.0.59144)

EANUPC string

Item barcode

Type: varchar (13)

Available from: / (25.7.0.59144)

Enabled boolean

Item state (enabled/disabled)

Type: bit

Available from: / (25.7.0.59144)

ItemKey integer

Item ID

Type: int

Available from: / (25.7.0.59144)

PriceVK number

Item price

Type: money

Available from: / (25.7.0.59144)

SupplNR string

Item supplier code

Type: varchar (4)

Available from: / (25.7.0.59144)

Category string

Item category

Type: varchar (50)

Available from: / (25.7.0.59144)

ItemName string

Item name

Type: varchar (120)

Available from: / (25.7.0.59144)

ItemTAGs string

Tags connected to the item

Type: varchar (8000)

Available from: / (25.7.0.59144)

Quantity integer

Item stock quantity

Type: int

Available from: / (25.7.0.59144)

VATLevel string

Item VAT level

Type: varchar (9)

Available from: / (25.7.0.59144)

ItemNrInt string

Item shop number

Type: varchar (50)

Available from: / (25.7.0.59144)

OrderUnit string

Packing unit

Type: varchar (50)

Available from: / (25.7.0.59144)

SupplPrice number

Supplier price of the item

Type: money

Available from: / (25.7.0.59144)

ItemNrSuppl string

Item supplier number

Type: varchar (50)

Available from: / (25.7.0.59144)

MinOrderQty integer

Minimum order quantity NOTE: this is always shown. Not @LocId needed.

Type: int

Available from: / (25.7.0.59144)

MinStockQty integer

Minimum stock quantity NOTE: Is only shown when @LocId is spedified else it is 0.

Type: int

Available from: / (25.7.0.59144)

SafetyStock integer

Item safety stock quantity (0 if no LocID provided)

Type: int

Available from: / (25.7.0.59144)

TargetStock integer

Item target stock quantity (0 if no LocID provided)

Type: int

Available from: / (25.7.0.59144)

PicLinkLarge string

Large picture URL

Type: varchar (512)

Available from: / (25.7.0.59144)

PicLinkSmall string

Small picture URL

Type: varchar (512)

Available from: / (25.7.0.59144)

ItemDescription string

Item description

Type: varchar (4000)

Available from: / (25.7.0.59144)

InternalItemNumber string

pixi* internal item number

Type: varchar (50)

Available from: / (25.7.0.59144)

ExportEstimatedDelivery string

Estimated delivery date

Type: datetime

Available from: / (25.7.0.59144)

2. Error response

Name Type Description
Error string

Error status

Type: varchar(20)

Available from: / (25.7.0.59144)

ErrorMsg string

Error description

Type: varchar(256)

Available from: / (25.7.0.59144)