Recommended

Retrieve Orderlines based on several filters.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:


Request

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

Request body

Name Type Required Description
ShopID string false

Shop ID

Type: varchar(3)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Status string false

Orderline Status

Type: varchar(3)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNR integer false

pixi* order number

Type: int

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

RowCount integer false

Maximum number of rows returned

Type: int

Default value: 1000

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

InvoiceNr string false

Invoice number

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderDateTo string false

End of order date range

Type: datetime

Default value:

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

Available from: LOU Official - Update 46 (6.9.46.27927)

PaymentType string false

Payment TYPE, references table payments

Type: char

Default value:

Example: Single character : "g"

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderlineKey integer false

Order line ID, references table Orderlines

Type: int

Default value:

Example: 123

Available from: LOU Official (6.3.0.4452)

UpdateDateTo string false

End of the date range when order line was updated

Type: datetime

Default value:

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

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderDateFrom string false

Beginning of the order date range

Type: datetime

Default value:

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

Available from: LOU Official - Update 46 (6.9.46.27927)

ShowOrderlines boolean false

Force to return Orderlinekey in case of bundle

Type: bit

Default value: 0

Example: 0 or 1

Available from: 20.04 (9.0.14.47944)

UpdateDateFrom string false

Beginning of the date range when order line was updated

Type: datetime

Default value:

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

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNRExternal string false

Shop order number

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Get Orderline Overview

Name Type Description
Qty integer

Qty

Type: int

Available from: 25.06 (25.6.0.58802)

Price number

Price

Type: money

Available from: 25.06 (25.6.0.58802)

EANUPC string

Item barcode

Type: varchar

Available from: 25.06 (25.6.0.58802)

Status string

Status

Type: varchar

Available from: 25.06 (25.6.0.58802)

ArtName string

Name of the item

Type: varchar

Available from: 25.06 (25.6.0.58802)

ItemRef integer

Item ID

Type: int

Available from: 25.06 (25.6.0.58802)

OrderNR integer

Order number in pixi*

Type: int

Available from: 25.06 (25.6.0.58802)

VATRate string

VAT Rate

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipDate string

Ship this order at this date only! not before

Type: datetime

Available from: 25.06 (25.6.0.58802)

FullPrice number

Full Price

Type: money

Available from: 25.06 (25.6.0.58802)

ItemNrInt string

Shop item number

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderDate string

Order Date

Type: datetime

Available from: 25.06 (25.6.0.58802)

DFShipDate string

DF Ship Date

Type: datetime

Available from: 25.06 (25.6.0.58802)

PriceNoVAT number

Price No VAT

Type: money

Available from: 25.06 (25.6.0.58802)

StatusText string

Status Text

Type: varchar

Available from: 25.06 (25.6.0.58802)

UpdateDate string

Last update date of the record

Type: datetime

Available from: 25.06 (25.6.0.58802)

DiscountPerc number

Discount Perc

Type: numeric

Available from: 25.06 (25.6.0.58802)

OrderlineKey integer

ID for the Orderline record

Type: int

Available from: 25.06 (25.6.0.58802)

DiscountValue number

Discount Value

Type: money

Available from: 25.06 (25.6.0.58802)

OrderCurrency string

Order Currency

Type: varchar

Available from: 25.06 (25.6.0.58802)

ReservedCount number

Reserved Count

Type: numeric

Available from: 25.06 (25.6.0.58802)

ItemNrExternal string

Item number external (Imported from Shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderNrExternal string

External order number

Type: varchar

Available from: 25.06 (25.6.0.58802)

FullPriceForItem number

Full Price For Item

Type: money

Available from: 25.06 (25.6.0.58802)

oItemSpecialNote string

oItem Special Note

Type: varchar

Available from: 25.06 (25.6.0.58802)

EstimatedDelivery string

Estimated Delivery

Type: datetime

Available from: 25.06 (25.6.0.58802)

AvailStockOrderLine integer

Avail Stock OrderLine

Type: int

Available from: 25.06 (25.6.0.58802)

DFShipmentTrackingID string

Direct fullfilement shipment tracking ID

Type: varchar

Available from: 25.06 (25.6.0.58802)