API Call to return

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: API call to return delivery documents.


Request

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

Request body

Name Type Required Description
LocID string false

Filter: Location id

Type: varchar(3)

Default value: NULL

Example: 001

Available from: LOU Official - Update 46 (6.9.46.27927)

Closed boolean false

Filter: Return only documents on closed status.

Type: bit

Default value: 0

Example: 1

Available from: LOU Official - Update 46 (6.9.46.27927)

EANUPC string false

Filter: Barcode

Type: varchar(200)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

Offset integer false

Offset for delivery header id

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Invoice boolean false

Filter: Return only documents on invoice status

Type: bit

Default value: 0

Example: 1

Available from: LOU Official - Update 46 (6.9.46.27927)

SupplNr string false

Filter: Supplier number

Type: varchar(200)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

ItemName string false

Filter: Item name

Type: varchar(200)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

RowCount integer false

Maximim number of rows

Type: int

Default value: 100

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

SDelHKey integer false

Filter: Delivery header id

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

ItemNrInt string false

Filter: Internal item number

Type: varchar(200)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

PiccoUser string false

Filter: Picco user

Type: varchar(50)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

ItemNrSuppl string false

Filter: Supplier item number

Type: varchar(200)

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateDateTo string false

Filter: Create date of Delivery (to)

Type: datetime

Default value: NULL

Example: 20190515

Available from: 19.09 (9.0.7.42222)

UpdateDateTo string false

Filter: Update date of Delivery (to)

Type: datetime

Default value: NULL

Example: 20190515

Available from: 19.09 (9.0.7.42222)

CreateDateFrom string false

Filter: Create date of Delivery (from)

Type: datetime

Default value: NULL

Example: 20190505

Available from: 19.09 (9.0.7.42222)

DeliveryNumber integer false

Filter: Delivery number

Type: int

Default value: NULL

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateFrom string false

Filter: Update date of Delivery (from)

Type: datetime

Default value: NULL

Example: 20190505

Available from: 19.09 (9.0.7.42222)


Response

1. Result

Name Type Description
SDelHNr integer

Delivery number

Type: int

Available from: 25.06 (25.6.0.58802)

SDelHKey integer

Delivery header ID

Type: int

Available from: 25.06 (25.6.0.58802)

PiccoUser string

Picco user

Type: varchar (59)

Available from: 25.06 (25.6.0.58802)

SDelHDate string

Delivery date

Type: datetime

Available from: 25.06 (25.6.0.58802)

SDelHNote string

Note

Type: varchar (8000)

Available from: 25.06 (25.6.0.58802)

SupplName string

Supplier name

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)

SDelHStatus string

Status

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

SDelHSupplNr string

Supplier number

Type: varchar (4)

Available from: 25.06 (25.6.0.58802)

LockedByPicco string

Is locked by picco user

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

SDelHCreateEmp string

Created by user

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

SDelHUpdateEmp string

Updated by user

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

SDelHCreateDate string

Date of creation

Type: datetime

Available from: 25.06 (25.6.0.58802)

SDelHLocationID string

Location Id

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

SDelHUpdateDate string

Date od update

Type: datetime

Available from: 25.06 (25.6.0.58802)

SDelHextOrderNr string

External order number

Type: varchar (1000)

Available from: 25.06 (25.6.0.58802)

SDelHextInvoiceNr string

External invoice number

Type: varchar (25)

Available from: 25.06 (25.6.0.58802)

SDelHfinalDicsount number

Final discount

Type: money

Available from: 25.06 (25.6.0.58802)