Services

Add. materials

Description WS Order Line Status Details V2 ver. 1.1.7

 

Description WS Order line status details V2:

1 Service, «Detailed information on the order number (ver. 2) getOrder2», differences from the previous version are highlighted in blue

1.1 Input parameters:

Parameter

Name

Type(max-size)

Required

Note

VKORG

Sales organization

line (4)

Yes

The parameter setting is located in "Service for receiving sales organizations of the client".
Example of filling VKORG=4000

KUNRG

Buyer

line (10)

Yes

The available values are returned to the "Client Structure Retrieval Service". Table RG_TAB-KUNNR
Example of filling KUNNR_RG=00000000

ORDER

Order number

line (10)

Yes

Number of the created order created by the buyer KUNRG.

STATUS

Deciphering statuses

0,1,or empty line (1)

No

If the STATUS field = 1, then a complete description of statuses by position will be added to the service result
 

            Added new parameter STATUS

1.2 Service response:

  • Table (array) HEADER

 

Parameter

Name

Type(max-size)

Required

Note

ORDER

Order number

line (10)

No

Number of the created order created by the buyer KUNRG.

ORDER_TYPE

Order type

line (100)

No

The order type depends on the place of shipment (marked in different colors in the ETP), takes the following values:
Shipment from the MAIN ARMTEK warehouses
Delivery from NEAR ARMTEK warehouses
Delivery from DISTANT warehouses ARMTEK
Delivery from central lock

ORDER_STATUS

Order status

line (100)

No

Order status can take the following values (in the ETP there is an icon next to the number):
Created
At work
Closed
Rejected

ORDER_DATE

Order date

line (20)

No

Date format YYYYMMDDHHIISS
Example of filling DLVDT=20181005120000

ORDER_SUM

Order Amount

line (20)

No

Order amount.
Important! Applies ONLY to the Order, if the Order was delivered in parts (see Delivery), then the report will have more than the 1st line with this Order Number and in each line the value "Order Amount" will be the same (same as in ETP)

CURRENCY

Currency

line (4)

No

 

KUNRG

Buyer

line (10)

No

The available values are returned to the "Client Structure Retrieval Service". Table RG_TAB-KUNNR
Example of filling KUNNR_RG=00000000

NAMERG

Name of buyer

line (100)

No

 

KUNWE

Consignee

line (10)

No

 

NAMEWE

Name of consignee

line (100)

No

 

KUNZA

Delivery address|Pickup point

line (10)

No

Available values are returned by the "Service for obtaining client structure".
For delivery - table RG_TAB->ZA_TAB-KUNNR
For pickup - table RG_TAB->EWX_TAB-ID
Example of filling KUNNR_ZA=00000000

NAMEZA

Delivery address|Pickup point

line (10)

No

Available values are returned by the "Service for obtaining client structure".
For delivery - table RG_TAB->ZA_TAB-KUNNR
For pickup - table RG_TAB->EWX_TAB-ID
Example of filling KUNNR_ZA=00000000

ADDRZA

Delivery address

line (100)

No

 

PARNRAP

Order Creator Code

line (10)

No

 

NAMEAP

Name of the Order Creator

line (100)

No

 

PARNRZP

Contact person

line (10)

No

The available values are returned to the "Client Structure Retrieval Service". Table RG_TAB->CONTACT_TAB-PARNR
Example of filling PARNR=00000000

NAMEZP

Name of Contact Person

line (100)

No

 

ETDAT

Supply goods C

line (20)

No

Date format YYYYMMDDHHIISS
Example of filling DLVDT=20181005120000

VDATU

Deliver goods by

line (20)

No

Date format YYYYMMDDHHIISS
Example of filling DLVDT=20181005120000

DOC_NUM

Order number in the Client’s accounting system

line (20)

No

 

DOC_DATE

Order date in the Client’s accounting system

line (14)

No

 

NUMDOG

Contract number

line (100)

No

 

COMPL_DLV

Full delivery

0,1,or empty line (1)

No

1 - yes.
0 - no.

COMMENT

Comment on order

line (100)

No

 

COMMENT_EXP

Commentary on the expedition

line (100)

No

 

INCOTERMS_TXT

Delivery type

line (100)

No

Takes the following values:
Delivery to the Client
Pickup

VSTELT

Name of Issue Point

line (100)

No

 
 

 

  • Table (array) ITEMS

 

Parameter

Name

Type(max-size)

Required

Note

POSNR

Item number in the order

line (10)

No

 

BRAND

Brand

line (<18)

No

Brand name

PIN

Item number

line (<40)

No

PIN (search string)

NAME

Name

line (100)

No

Item name

KWMENG

Quantity in order

line (20)

No

Quantity "In order"

KWMENG_P

For delivery

line (20)

No

Quantity "For delivery" if <> 0 then displays the quantity ready for shipment to the Client

KWMENG_R

Shipped quantity

line (20)

No

Quantity "Shipped" quantity ALREADY shipped to the Client

KWMENG_REJ

Rejected quantity

line (20)

No

Quantity "Rejected" which was rejected

PRICE

Price per unit

line (20)

No

Price per item Item

SUMMA

Amount

line (10)

No

 

CURRENCY

Currency

line (4)

No

 

STATUS

Position status

line (100)

No

Accepts values:
- empty value
- the position is fully set
- the position is partially delivered
- position partially rejected
- position is completely rejected

NOTE

Note

line (100)

No

Item Note

DLVRD

Expected date

line (20)

No

Date format YYYYMMDDHHIISS
Example of filling DLVDT=20181005120000

WRNTD

Guaranteed date

line (20)

No

Date format YYYYMMDDHHIISS
Example of filling DLVDT=20181005120000

ABGRU_TXT

Reason for deviation

line (100)

No

If a position is rejected, the text Reasons for rejection is displayed

MATNR

Material

line (18)

No

 

COMPL_DLV

Full delivery

0,1,or empty line (1)

No

1 - yes.
0 - no.

POSEX

Link to "Parent Position"

line (6)

No

Number of the parent position from which the reorder was made, or the item was transferred to substandard condition. Positions are numbered sequentially for several reorders, forming a chain of reorders

POSROOT

Link "To root position"

line (6)

No

Root position number. This number is referenced by all created dependent items

CHARG

Sign of substandard

line (10)

No

If NOT empty, then this position contains substandard goods. In the ETP you can see the photo

CHARG_BLK

Sign of blocking substandard conditions for shipment

bool (1)

No

If = True, then this item of substandard goods is blocked for shipment and a decision must be made on whether to ship it or not. You can unblock it in the ETP when editing the order or you need to contact the manager

SUPPLIER

ARMTEK partner warehouse code

number (10)

No

If the product is from a partner’s warehouse (CP), then this field displays the partner’s warehouse code

ZZKWMENG

Originally ordered quantity

line (20)

No

1. When ordering from partner warehouses, if it is impossible to supply the required quantity in full, then the value in the KWMENG field can be reduced, but the value in this field will remain unchanged.

2. If it is not possible to supply the entire quantity, the system rejects the entire item and reorders the item from another supplier, creating new lines in the order that reference the parent item. There may be multiple lines when reordering, but the total quantity is stored in this field of the parent item.

3. Corresponds to the «Ordered» field in the ETP in «Order details»

REJECTED

Total rejected quantity

line (20)

No

1. The total rejected quantity that can no longer be delivered. If this is an order item from the central warehouse (from partner warehouses), which has been reordered, then in all related positions that have the same root position (the same value in the POSROOT field), the value in this field will be the same. When used, cannot be summed for related items!

2. Corresponds to the «Rejected» field in the ETP in «Order details»

PROCESSING

Quantity that is «In work»

line (20)

No

The amount that:

1. In progress, but not yet ready for shipment

2. Does not include the value from the REJECTED

field

3. Corresponds to the «In progress» field in the ETP in «Order details»

READY

Quantity that «Ready for shipment»

line (20)

No

Includes that quantity which:

1. Located in the warehouse for shipment to the client and awaiting shipment in accordance with the method and conditions of shipment to the client.

2. Is in «delivery», i.e., the quantity that has already begun to be stocked in the warehouse for shipment to the client.

3. Corresponds to the «Ready for shipment» field in the ETP in «Order details»

REJ_MENGE

Quantity that the client refused

line (20)

No

Upon delivery, if the client refuses to pick up all or part of the goods, then the driver registers «Customer Refusal» and this field displays the quantity that the client refused quantity

ReadyToIssue

Ready for issue

line (20)

No

Issued

Issued

line (20)

No

 

 

2  The service operates in 2 modes:

2.1 Order line status mode corresponds to the statuses displayed in the ETP on the «Order details» page (URL = etp.armtek.*/order/index/*):

2.2 New functionality "Decoding of statuses", to receive data with decoding of position statuses, you must set the STATUS parameter in the service = 1. As a result, a new complex structure (nested arrays) is added to the response:

  • STATUSES. At the first level there is a table (array), the elements of which refer to the order line with the fields:

 

Parameter

Name

Type(max-size)

Required

Note

ORDER

Order number

line (10)

Yes

Order number

POSNR

Item number in the order

line (10)

Yes

Order item number

QUAN

Quantity

line (20)

Yes

Quantity to decrypt

VSTELNAME

Name of Issue Point

line (100)

Yes

Name of the Pickup Point from which the goods will be shipped

Processing

In processing

line (20)

No

Quantity being processed:

  • For orders from partner warehouses (CP), this quantity includes both processing at the partner’s warehouses (its code is in the SUPPLIER field) and processing at ARMTEK warehouses after receiving the goods.
  • For orders from ARMTEK warehouses, it contains the quantity in processing at  warehouses in the logistics chain ARMTEK

Ready

Ready for shipment

line (20)

No

Quantity that is in the shipping warehouse and is ready for shipment to the customer.

Delivered

Shipped

line (20)

No

Quantity that has already been shipped to the customer.

 

 

 

 

 
 
  • Decoding of statuses is available separately for each status: Processing, Ready and Delivered
  • Decryption is presented in the form of tables (arrays) at the following levels

2.3 Status Delivered means that the goods have already been shipped and there are invoice documents for this. The information is placed in the following table (array):

 

Parameter

Name

Type(max-size)

Required

Note

InvoiceNum

Invoice number

line (10)

Yes

System Invoice Number

InvoicePos

Item number in the invoice

line (10)

Yes

Invoice item number

PrintNum

Printed invoice number

line (15)

Yes

Number of the printed document on the invoice: UPD/Tovchek

Waybill

TN/TTN number

line (15)

No

TN/TTN number if available.

CreateTime

Date and time of creation

Line (14)

Yes

Date and time of creation of the invoice in the format

YYYYMMDDHHMMSS

Quan

Quantity

line (20)

Yes

Quantity in invoice line

Unit

EI

line (3)

Yes

Quantity unit

Cost

Cost

line (20)

Yes

Cost by invoice line

Currency

Currency

line (3)

Yes

Currency

ShippedTime

Not used

-

No

Not in use yet

DeliveryNum

Delivery number

line (10)

Yes

Number of the associated document «delivery».
 
  • If 1 invoice is issued for 2 or more deliveries, then there will be 2 or more elements with the same data, but different values DeliveryNum
  • If the order item was shipped in parts, then each shipment will have its own section with its own invoice number.

2.4 Status Ready means that the product is ready for shipment. The information is placed in the following table (array):

 

Parameter

Name

Type(max-size)

Required

Note

DeliveryNum

Delivery number

line (10)

No

Document number «delivery». This means that the assembly process has already begun at the shipping warehouse.

DeliveryPos

Item number in delivery

line (6)

No

Delivery item number

DeliveryTime

Date and time of creation

line (14)

No

Date and time of creation of the delivery in the format

YYYYMMDDHHMMSS

DeliveryQuan

Quantity

line (20)

No

Quantity in delivery item

DeliveryUnit

EI

line (3)

No

Unit of quantity change

WarehouseQuan

Quantity in shipping warehouse

line (20)

No

Quantity is in the shipping warehouse but has not yet started shipping.

DateDelNew

Date of receipt by client

line (14)

No

The estimated date of receipt of the goods, which is calculated based on the current condition.

YYYYMMDDHHMMSS
 

 

  • If DeliveryQuan = «empty» This means the product is simply «In the shipping warehouse» in quantity WarehouseQuan
  • If DeliveryQuan = NOT «empty» this means the warehouse has already started selecting goods.

2.5 Status Processing — the most difficult status to decipher, because reflects both the condition of the goods from the partner in the case of an order from the Purchasing Center (CP), and the condition of the goods in all ARMTEK warehouses in accordance with the logistics chain. This status always indicates that the product is not yet ready for shipment. Because the status is complex, then the concept SubStatus has been introduced for it. The information is placed in the following table (array):

Parameter

Name

Type(max-size)

Required

Note

SubStatus

Substatus

line (10)

Yes

Can take the following values:

  • WayQuan — the goods are in transit between points in the supply chain
  • Planned — scheduled for purchase from a partner, but the purchase order has not yet been placed
  • Waiting — refers to a partner, means waiting for confirmation of a purchase order placed with a partner
  • Confirmed — the partner confirmed his readiness to ship the goods
  • Shipped — the partner shipped the goods to ARMTEK

Werks

ARMTEK warehouse code

line (4)

No

ARMTEK warehouse code where the current SubStatus

WerksName

Name of ARMTEK warehouse

line (60)

No

Name of the ARMTEK warehouse where the current SubStatus

Lgort

Not used

line (20)

No

Not used

LsegETP

Description

line (60)

No

Explanation of the current SubStatus

Quan

Quantity

line (20)

Yes

The quantity that is in the corresponding SubStatus.

Bldat

Date of last event

line (8)

No

Date when the SubStatus change occurred. Can be empty if SubStatus informational.

Cputm

Last event time

line (6)

No

Time when the SubStatus change occurred. Can be empty if SubStatus informational.

Unit

EI

line (3)

Yes

Quantity unit

DateDelNew

Date of receipt by client

line (14)

No

The estimated date of receipt of the goods, which is calculated based on the current status (date and time of the last event for SubStatus).

YYYYMMDDHHMMSS
 

 

2.6 If the Werks WerksName fields are not filled in, this means that the substance status relates to the partner’s warehouses: Planned, Waiting, Confirmed and Shipped

2.7 Substatus WayQuan:

  • If the field DateDelNew is filled in, then this means:
    • that the latest event on the product is related to movement along the ARMTEK supply chain
    • display the specific warehouse in which this event occurred.
    • The LsegETP field is also filled in. which explains the condition of the goods, for example «At acceptance» or «On the way to the shipping warehouse».
  • If the field DateDelNew is not filled in, this means:
    • that the goods are in transit from the partner’s warehouse to the first in the logistics chain, the ARMTEK warehouse, which is present in the Werks and WerksName fields.
    • In this case there is also a full set of partner substatuses: Planned, Waiting, Confirmed and Shipped
    • in LsegETP there is an explanation «We are awaiting arrival from the supplier»
    • and the most current  DateDelNew for this position is in the section with substatus =  Shipped