pixiReadItems

API Call to retrieve all items. For better results use API call pixiReadAddItems .

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:


Request

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

Request body

Name Type Required Description
ItemKey integer false

pixi* Item Key

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

RowCount integer false

number of rows returned maximum

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateDateTo string false

Create Date to (excluding)

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateTo string false

Update Date To (excluding)

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateDateFrom string false

Create Date from (including)

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateFrom string false

Update Date from (including)

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateAndUpdateDateTo string false

Create or Update Date to (excluding)

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateAndUpdateDateFrom string false

Create or Update Date from (including)

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Item information

Name Type Description
UPC string

Type: varchar

Available from: / (26.9.0.14135)

VPE string

Field is deprecated

Type: smallint

Available from: / (26.9.0.14135)

Price number

Type: money

Available from: / (26.9.0.14135)

Width number

Type: numeric

Available from: / (26.9.0.14135)

EANUPC string

Item barcode

Type: varchar

Available from: / (26.9.0.14135)

Heigth number

Type: numeric

Available from: / (26.9.0.14135)

Length number

Type: numeric

Available from: / (26.9.0.14135)

Weight number

Weight in grams

Type: numeric

Available from: / (26.9.0.14135)

DisDate string

Field is deprecated

Type: datetime

Available from: / (26.9.0.14135)

Enabled boolean

Type: bit

Available from: / (26.9.0.14135)

ItemKey integer

pixi* item ID

Type: int

Available from: / (26.9.0.14135)

RelDate string

Field is deprecated

Type: datetime

Available from: / (26.9.0.14135)

SupplNr string

Supplier number (code)

Type: varchar

Available from: / (26.9.0.14135)

IsBundle boolean

Type: bit

Available from: / (26.9.0.14135)

ItemName string

Item name

Type: varchar

Available from: / (26.9.0.14135)

MwStSatz string

VAT Rate

Type: smallint

Available from: / (26.9.0.14135)

Quantity integer

Type: int

Available from: / (26.9.0.14135)

AutoPrice boolean

Type: bit

Available from: / (26.9.0.14135)

DataSuppl string

Type: varchar

Available from: / (26.9.0.14135)

ItemNrInt string

Shop item number

Type: varchar

Available from: / (26.9.0.14135)

ItemNrOld string

Type: varchar

Available from: / (26.9.0.14135)

OrderUnit string

Type: varchar

Available from: / (26.9.0.14135)

SupplName string

Supplier name

Type: varchar

Available from: / (26.9.0.14135)

TontrText string

Name of the category

Type: varchar

Available from: / (26.9.0.14135)

UpdateEmp string

User who last updated the record

Type: varchar

Available from: / (26.9.0.14135)

ConfigType string

Type: varchar

Available from: / (26.9.0.14135)

CreateDate string

Create date

Type: smalldatetime

Available from: / (26.9.0.14135)

SupplPrice number

Supplier price of the item

Type: money

Available from: / (26.9.0.14135)

UpdateDate string

Last update date of the record

Type: smalldatetime

Available from: / (26.9.0.14135)

Curr_Source string

Type: varchar

Available from: / (26.9.0.14135)

ItemNrSuppl string

Supplier item number

Type: varchar

Available from: / (26.9.0.14135)

MinOrderQty integer

Field is deprecated

Type: int

Available from: / (26.9.0.14135)

MinStockQty integer

Minimum stock quantity for the item

Type: int

Available from: / (26.9.0.14135)

Manufacturer string

Name of the manufacturer

Type: varchar

Available from: / (26.9.0.14135)

PicLinkLarge string

URL to picture of the item (large size)

Type: varchar

Available from: / (26.9.0.14135)

PicLinkSmall string

URL to picture of the item (small size)

Type: varchar

Available from: / (26.9.0.14135)

BookAccountEu string

Type: varchar

Available from: / (26.9.0.14135)

ExportQtyAvail integer

Field is deprecated

Type: int

Available from: / (26.9.0.14135)

LastImportDate string

Type: datetime

Available from: / (26.9.0.14135)

AvgDeliveryTime integer

Field is deprecated

Type: int

Available from: / (26.9.0.14135)

BookAccountNonEu string

Type: varchar

Available from: / (26.9.0.14135)

SerialNrRequired boolean

Type: bit

Available from: / (26.9.0.14135)

CustomsTariffText string

Customs Tariff Text imported for the item with item import

Type: varchar

Available from: / (26.9.0.14135)

BookAccountEU_Suppl string

Type: varchar

Available from: / (26.9.0.14135)

CustomsTariffNumber string

Type: varchar

Available from: / (26.9.0.14135)

ImputedSupplierPrice number

Supplier price with added cost of transportation, handling, etc.

Type: money

Available from: / (26.9.0.14135)

BookAccountEuCompanies string

Type: varchar

Available from: / (26.9.0.14135)

BookAccountNonEU_Suppl string

Type: varchar

Available from: / (26.9.0.14135)

CustomsCountryOfOrigin string

Country of Origin imported for the item with item import (ISO-2 format)

Type: varchar

Available from: / (26.9.0.14135)

CustomsPreviousProcess string

Type: varchar

Available from: / (26.9.0.14135)

ExportReportedQtyAvail integer

Field is deprecated

Type: int

Available from: / (26.9.0.14135)

ExportEstimatedDelivery string

Type: datetime

Available from: / (26.9.0.14135)

BookAccountEUCompanies_Suppl string

Type: varchar

Available from: / (26.9.0.14135)