pixiReportGetShippableOrders

Multi Currency: Return database currency code in field dbCurrency depend on if Multi Currency is Enabled then we:

  • calculate and return data in database currency else
  • calculate and return data in order / original currency (with value NULL for currency code).

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


Request

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

Request body

Name Type Required Description
ShopId string false

Shop Code

Type: varchar(3)

Default value:

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)

PerLocation boolean false

Return summary of shippable orders per location.

Type: bit

Default value: 0

Example: 0 or 1

Available from: 21.01 (9.0.23.54983)

ViewDetails boolean false

Return summarized output or return detailed output.

Type: bit

Default value:

Example: 0 or 1

Available from: LOU Official (6.3.0.4452)

OnlyPartDelivery boolean false

Show only orderlines which were partially delivered

Type: bit

Default value:

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)

IncludePartDelivery boolean false

Include also orderlines which were partially delivered.

Type: bit

Default value:

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)

IncludeOrdersWithAnyShipDate boolean false

By default, return all orders without ship date and orders where shipdate =< today. Exclude order where ship date is in the future. If parameter @IncludeOrdersWithAnyShipDate = 1 then return all orders (ship date is ignored)

Type: bit

Default value: 0

Example: 0 or 1

Available from: AVA 17.03 (8.4.27.29272)


Response

1. Detailed output for @PerLocation = 0

Name Type Description
Qty integer

Orderline Quantity

Type: int

Available from: 25.06 (25.6.0.58802)

Price number

Orderline Price

Type: money

Available from: 25.06 (25.6.0.58802)

Status string

Orderline Status

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

ItemRef integer

Item ID

Type: int

Available from: 25.06 (25.6.0.58802)

OrderNr integer

pixi Order Number

Type: int

Available from: 25.06 (25.6.0.58802)

ShipCost number

The total shipping costs of the whole order

Type: money

Available from: 25.06 (25.6.0.58802)

Shippable integer

Marks if there is enough stock to ship orderline

Type: int

Available from: 25.06 (25.6.0.58802)

dbCurrency string

Database Currency

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

OrderlineRef integer

Orderline id

Type: int

Available from: 25.06 (25.6.0.58802)

2. Summarized output for @PerLocation = 0

Name Type Description
Picks integer

Summarized quantity which is available to be shipped

Type: int

Available from: 25.06 (25.6.0.58802)

Orders integer

Order count

Type: int

Available from: 25.06 (25.6.0.58802)

ShipCost number

Summarized shipping costs

Type: money

Available from: 25.06 (25.6.0.58802)

OrderTotal number

Summarized order total

Type: money

Available from: 25.06 (25.6.0.58802)

dbCurrency string

Database Currency

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

3. Detailed output for @PerLocation = 1

Name Type Description
Qty integer

Orderline Quantity

Type: int

Available from: 25.06 (25.6.0.58802)

Price number

Orderline Price

Type: money

Available from: 25.06 (25.6.0.58802)

Status string

Orderline Status

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

ItemRef integer

Item ID

Type: int

Available from: 25.06 (25.6.0.58802)

OrderNr integer

pixi Order Number

Type: int

Available from: 25.06 (25.6.0.58802)

ShipCost number

The total shipping costs of the whole order

Type: money

Available from: 25.06 (25.6.0.58802)

Shippable integer

Marks if there is enough stock to ship orderline

Type: int

Available from: 25.06 (25.6.0.58802)

LocationID string

Location of shippable orders.

Type: varchar(3)

Available from: 25.06 (25.6.0.58802)

dbCurrency string

Database Currency

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

OrderlineRef integer

Orderline id

Type: int

Available from: 25.06 (25.6.0.58802)

4. Summarized output for @PerLocation = 1

Name Type Description
Picks integer

Summarized quantity which is available to be shipped

Type: int

Available from: 25.06 (25.6.0.58802)

Orders integer

Order count

Type: int

Available from: 25.06 (25.6.0.58802)

ShipCost number

Summarized shipping costs, when the Order have lines on multiple locations, the same shipcost amount will apear on all location (duplicated value)

Type: money

Available from: 25.06 (25.6.0.58802)

LocationID string

Location of shippable orders.

Type: varchar(3)

Available from: 25.06 (25.6.0.58802)

OrderTotal number

Summarized order total

Type: money

Available from: 25.06 (25.6.0.58802)

dbCurrency string

Database Currency

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)