pixiGetShippedOrdersPerLocation

Get list of all shipped orders for time period, if ShowDetails=0 only number of orders, their total and currency will be returned.

Since pixi version: 21.01 (9.0.23.54983) Additional notes:


Request

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

Request body

Name Type Required Description
LocId string false

Filter: All locations = empty string |one specific location = 001.

Type: varchar(3)

Default value: NULL

Example: abc

Available from: 21.01 (9.0.23.54983)

ToDate string true

Filter: End of invoice date range.

Type: varchar(25)

Default value:

Example: 2017-12-31 23:59:96

Available from: 21.01 (9.0.23.54983)

FromDate string true

Filter: Start of invoice date range.

Type: varchar(25)

Default value:

Example: 2017-01-01 00:00:00

Available from: 21.01 (9.0.23.54983)

ShowDetails integer false

Return details or summary of shipped orders.

Type: int

Default value: 1

Example: 0

Available from: 21.01 (9.0.23.54983)

CustomerNrExternal string false

Filter: Customer number external.

Type: varchar(60)

Default value: NULL

Example: abc

Available from: 21.01 (9.0.23.54983)

SearchByScanOutDate boolean false

Filter: Select if @FromDate and @ToDate filter records by InvoiceDate (default) or by ScanOutDate.

Type: bit

Default value: 0

Example: 0 or 1

Available from: 21.01 (9.0.23.54983)

IncludeOrdersWithTotalZero boolean false

Filter: Include orders with total = 0 in returned result set.

Type: bit

Default value: 0

Example: 0 or 1

Available from: 21.01 (9.0.23.54983)


Response

1. Shipped orders (details).

Name Type Description
SZip string

Postal code from shipping address.

Type: varchar

Available from: 25.06 (25.6.0.58802)

SCity string

City from shipping address.

Type: varchar

Available from: 25.06 (25.6.0.58802)

SName string

Customer name from shipping address.

Type: varchar

Available from: 25.06 (25.6.0.58802)

total number

Invoice total.

Type: money

Available from: 25.06 (25.6.0.58802)

InvDate string

Date of invoice creation.

Type: datetime

Available from: 25.06 (25.6.0.58802)

SAddress string

Street from shipping address.

Type: varchar

Available from: 25.06 (25.6.0.58802)

SCountry string

Country from shipping address.

Type: varchar

Available from: 25.06 (25.6.0.58802)

InvoiceNR string

Invoice number.

Type: varchar

Available from: 25.06 (25.6.0.58802)

LocationID string

Location of shipped orders.

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipVendor string

Shipping vendor code.

Type: varchar

Available from: 25.06 (25.6.0.58802)

ScanOutDate string

Invoice ship out date.

Type: datetime

Available from: 25.06 (25.6.0.58802)

CurrencyCode string

Currency code.

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderNrExternal string

Order number external (shop order number).

Type: varchar

Available from: 25.06 (25.6.0.58802)

CustomerNrExternal string

External customer number.

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipMentTrackingID string

Invoice tracking ID.

Type: varchar

Available from: 25.06 (25.6.0.58802)

2. Shipped orders (summary).

Name Type Description
Total number

Invoice SUM(total) in selected period.

Type: money

Available from: 25.06 (25.6.0.58802)

LocationID string

Location of shipped orders.

Type: varchar

Available from: 25.06 (25.6.0.58802)

NrOfOrders integer

Total number of orders in selected period.

Type: int

Available from: 25.06 (25.6.0.58802)

CurrencyCode string

Currency code.

Type: varchar

Available from: 25.06 (25.6.0.58802)