API which retrieves supplier orders with corresponding suppliers. Pixi_GetSOrders drop because API call replaced this procedure.

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


Request

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

Request body

Name Type Required Description
RLimit integer false

Number of returned records.

Type: int

Default value: 0

Example:

Available from: LOU Official (6.3.0.4452)

ShowCls boolean false

Filter: Display supplier orders on status CLS.

Type: bit

Default value: 1

Example:

Available from: LOU Official (6.3.0.4452)

ShowCon boolean false

Filter: Display supplier orders on status CON.

Type: bit

Default value: 1

Example:

Available from: LOU Official (6.3.0.4452)

ShowNew boolean false

Filter: Display supplier orders on status NEW.

Type: bit

Default value: 1

Example:

Available from: LOU Official (6.3.0.4452)

ShowOrd boolean false

Filter: Display supplier orders on status BES.

Type: bit

Default value: 1

Example:

Available from: LOU Official (6.3.0.4452)

LocationID string false

Location on which you search for supplier orders.

Type: varchar(3)

Default value: 001

Example:

Available from: LOU Official (6.3.0.4452)

ShowNoDate boolean false

Decide whether to return SOrders with no estimated delivery date set. Only orders that are/were already ordered are considered.

Type: bit

Default value: 0

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)

ExtOrderNrs string false

Filter list of External order numbers in XML format.

Type: varchar(-1)

Default value: NULL

Example: <ExtOrders>

        <ExtOrder>

            <ExtOrderNr>EXT_001</ExtOrderNr>

        </ExtOrder>

        <ExtOrder>

            <ExtOrderNr>EXT_002</ExtOrderNr>

        </ExtOrder>

    </ExtOrders>

Available from: AVA 17.04 (8.4.28.29614)

ShowDueDate boolean false

Decide whether to return overdue SOrders. Only orders that are/were already ordered are considered.

Type: bit

Default value: 0

Example:

Available from: LOU Official (6.3.0.4452)

StatusChangeDateTo string false

Filter result to supplier orders where status change timestamp is after the parameter value.

Type: datetime

Default value: NULL

Example: 2017-01-31 23:23:59.996

Available from: AVA 17.04 (8.4.28.29614)

StatusChangeDateFrom string false

Filter result to supplier orders where status change timestamp is before the parameter value.

Type: datetime

Default value: NULL

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

Available from: AVA 17.04 (8.4.28.29614)


Response

1. Supplier orders

Name Type Description
Status string

Supplier order status

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderNr integer

Order number in pixi*

Type: int

Available from: 25.06 (25.6.0.58802)

SupplNr string

Supplier number (code)

Type: varchar

Available from: 25.06 (25.6.0.58802)

XMLsent boolean

Indicator that XML was sent

Type: bit

Available from: 25.06 (25.6.0.58802)

CreateEmp string

Creator of the record (pixi* user)

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderDate string

Supplier order date

Type: datetime

Available from: 25.06 (25.6.0.58802)

SOrderKey integer

Supplier order ID

Type: int

Available from: 25.06 (25.6.0.58802)

SupplName string

Supplier name

Type: varchar

Available from: 25.06 (25.6.0.58802)

UpdateEmp string

User who last updated the record

Type: varchar

Available from: 25.06 (25.6.0.58802)

CreateDate string

Create date

Type: datetime

Available from: 25.06 (25.6.0.58802)

ExtOrderNr string

External supplier order number

Type: nvarchar

Available from: 25.06 (25.6.0.58802)

SupplGroup string

Supplier group

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)

SOrdersNote string

Supplier order note

Type: varchar

Available from: 25.06 (25.6.0.58802)

GoodsReceipts string

List of SDelHNr (Supplier Delivery Header Nr) separated by semicolon.

Type: varchar

Available from: 25.06 (25.6.0.58802)

RecordBatchNr integer

Always "NULL"

Type: int

Available from: 25.06 (25.6.0.58802)

SOrderLocation string

Location of supplier order

Type: varchar

Available from: 25.06 (25.6.0.58802)

PixiOrderCreated boolean

Always "NULL"

Type: bit

Available from: 25.06 (25.6.0.58802)

SupplierFulfillment boolean

Indicator of direct fulfillment order

Type: bit

Available from: 25.06 (25.6.0.58802)