pixiFindOrderlineForBox

API returns most appropriate orderline from picklist for scanned-in item

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The API call can only be used when "Premium API" setting is enabled.


Request

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

Request body

Name Type Required Description
Box integer false

Box number

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Qty integer false

Item quantity

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

EANUPC string true

Item barcode

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNr string false

pixi* order number

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

UsedBoxes integer false

Number of used boxes

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

LocationID string true

Location ID

Type: varchar(3)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

PickListNr integer false

Picklist number

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

ExpressBoxes integer false

Number of express boxes

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderlineKey integer false

Orderline ID

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

SupplOrderNr integer false

Supplier order number

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

1SSnoPLscanIn boolean false

Use one scan shipping functionality

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Orderline details

Name Type Description
Qty integer

Orderline item quantity

Type: int

Available from: 25.06 (25.6.0.58802)

ArtNr string

Item barcode

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

PLqty integer

Item quantity on the picklist

Type: int

Available from: 25.06 (25.6.0.58802)

Status string

Orderline status

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

AddrRef integer

Billing adddress ID

Type: int

Available from: 25.06 (25.6.0.58802)

ArtName string

Name of the item.

Type: varchar (120)

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)

OrderDate string

Order date imported from the shop

Type: datetime

Available from: 25.06 (25.6.0.58802)

LocationID string

Order location code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

OutsideQty integer

Indicator that the quantity provided with parameters is higher than the one on the orderline

Type: int

Available from: 25.06 (25.6.0.58802)

ShipAdrRef integer

Shipping address ID

Type: int

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)

LastOrdLocationID string

Last order location code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

IsPersonalizedScanIn boolean

Indicates that the orderline item is a personalized item

Type: bit

Available from: 25.06 (25.6.0.58802)

2. Status output

Name Type Description
Status string

Execution status (OK/ERROR)

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)

StatusMessage string

Description of the status

Type: varchar (200)

Available from: 25.06 (25.6.0.58802)