Sidebar
en:tracking_interface
Table of Contents
Tracking - Interface
Header
| Element | Type | Possible values | Description |
|---|---|---|---|
| token | String | Unique ID of the transmission | |
| client_id | Int | Your PDI client ID | |
| client_name | String | Your PDI client name | |
| project_id | Int | Your project ID for the client number | |
| project_name | String | Your project name for the client number |
Parameters
If these parameters are included, the columns will show:
T = transaction
O = order
I = item
P = package
E = error
| Attribut | Type | Possible values | Description | T | O | I | P | E |
|---|---|---|---|---|---|---|---|---|
| id | Int | Unique ID of the message | x | x | x | x | x | |
| action | Enum | set_status | Type of message Reports the result of a status change in production | from v2.0 | from v2.0 | from v2.0 | from v2.0 | from v2.0 |
| action | Enum | status | Type of message Reports the result (confirmation) of a status change due to a command request. The assignment can be made with request_reference_id. If your request could not be processed, you will see this in the <errors> tag. | from v2.3 | from v2.3 | from v2.3 | from v2.3 | from v2.3 |
| action | Enum | exception | Type of message Reports an error and the current (generally unchanged) status due to a status change request that could not be processed, e.g. from a command request. In the case of a command request, the assignment can be made with request_reference_id. | from v2.0 | from v2.0 | from v2.0 | from v2.0 | from v2.0 |
| order_type | Enum | NORMAL, MANUAL, SAMPLE_INTERN, SAMPLE_CUSTOMER, TEST | Type of order | from v2.0 | x | x | ||
| timestamp | datetime | 2012-06-13 16:22:22 | Time of the change | x | x | x | x | x |
| transaction_reference | String | Unique ID of the transaction | x | x | x | x | ||
| transaction_reference_client | String | Reference of your transaction (filename of the XML) | x | x | x | x | ||
| status | Int | see Status codes | Current status | x | x | x | x | |
| status_desc | String | Description of the current status | x | x | x | x | ||
| duplicate | String | true, false | Specifies whether this was a copied order | x | x | |||
| production_delay | Int | See below… | Specifies whether there is a production delay. In this case, you will receive an updated finish_date | x | x | |||
| finish_date | Date | First the planned process end, generally the transfer to the shipping service provider. This is calculated upon receipt of the order based on the production tasks determined. The date is updated to the actual end of the process once the last task is complete. An update can take place if there is a production delay. Then the date is recalculated. Formula = day of the error plus regular production time (see Restart). | x | x | ||||
| order_reference | Int | Unique ID of the order | x | x | x | |||
| order_reference_client | String | The order reference you provided us | x | x | x | |||
| order_item_reference | Int | Unique ID of the item | x | x | ||||
| order_item_reference_client | String | The item reference you provided us | x | x | ||||
| quantity | Int | 123 | Portion of the ordered quantity. | x | x | |||
| order_item_barcode_client | String | If you transmitted an additional barcode to us | x | x | ||||
| package_reference | Int | Unique ID of the package | x | |||||
| type | Enum | pod, stock | Type of item | x | ||||
| batch | String | Batch number of the item | x | |||||
| best_before_date | String | 2013-03-17 | Best-before date of the item | x | ||||
| provider | String | See below… | Shipping service provider | x | ||||
| shipping_date | Date | 2012-07-04 | Date on which the package was completed by the logistics centre and ready for transfer to the shipping service provider. | x | ||||
| shipping_time | time | 16:25:13 | Time at which the package was completed by the logistics centre and ready for transfer to the shipping service provider. | x | ||||
| dhl_event | String | See below… | Code from DHL | x | ||||
| dhl_ric | String | See below… | Code from DHL | x | ||||
| dhl_event_category | String | See below… | Code from DHL | x | ||||
| delivery_date_calculated | Date | 2012-07-06 | Expected delivery date | x | ||||
| delivery_date | Date | 2012-07-07 | Actual delivery date | x | ||||
| delivery_time | String | 09:12:43 | Actual delivery time | x | ||||
| delivery_signed | String | MUELLER | Signed by upon delivery / name of the person who accepted delivery. | x | ||||
| delivery_delay | String | See below… | Reason for any delivery delay if tracking information is available from the shipping service provider. Note: The time of transfer to the shipping service provider applies. There is no dependency on the production process. A warning is issued if the agreed-upon delivery time is exceeded. A critical message is issued if the agreed-upon delivery time is exceeded by a large factor. If a delivery is stored in a subsidiary or Packstation, 7 days of waiting time is added to the agreed-upon delivery time. Based on assumptions! | x | ||||
| tracking_number | String | T1234567890 | Tracking number, if given to a shipping delivery provider who provides one. Note: If the package needs to be repicked in exceptional cases, you will receive a new tracking number. We therefore recommend providing tracking information / links to the end customer only after the package status has gone to “in delivery”. | x | ||||
| tracking_link | String | http://www.dhl.de/track?T1234567890 | Complete link to the tracking page of the shipping service provider, if available. | x | ||||
| express | Int | 0/1 | Indicates whether the package was shipped express. | x | ||||
| weight | Int | 300 | Weight of the package, in grams. | x | ||||
| errorcode | Int | See: Error codes | Error code for an error that occurred (action=exception) during import or transmission of the status. | from v2.0 | from v2.0 | from v2.0 | from v2.0 | x |
| request_reference_id | String | If the status change results from a command request, this attribute contains the unique ID you transmitted to us in your request. | from v2.3 | from v2.3 | from v2.3 | from v2.3 | x |
Child-Tags of Object Item (Item + Items of Package)
<details> = Container
<detail> = Contains detailed information of current status in Production.
Attributes = Integer for count of items.
For version 2.3
<details>
<detail name="DRUCK"><![CDATA[0]]></detail>
<detail name="WV"><![CDATA[0]]></detail>
<detail name="IMVERSAND"><![CDATA[0]]></detail>
<detail name="EINGELAGERT"><![CDATA[0]]></detail>
<detail name="KOMMISSIONIERT"><![CDATA[0]]></detail>
<detail name="VERSAND"><![CDATA[0]]></detail>
<detail name="RUECKLAEUFER"><![CDATA[0]]></detail>
<detail name="ZUGESTELLT"><![CDATA[0]]></detail>
<detail name="STORNO"><![CDATA[1]]></detail>
</details>
For version 2.4
<details>
<detail name="PRINT"><![CDATA[0]]></detail>
<detail name="FINISHING"><![CDATA[0]]></detail>
<detail name="IN_DELIVERY"><![CDATA[0]]></detail>
<detail name="STORED"><![CDATA[0]]></detail>
<detail name="PICKED"><![CDATA[0]]></detail>
<detail name="SHIPPING"><![CDATA[0]]></detail>
<detail name="RETURN"><![CDATA[0]]></detail>
<detail name="DELIVERED"><![CDATA[0]]></detail>
<detail name="CANCEL"><![CDATA[1]]></detail>
</details>
Child-Tags of all Objects
<message> = Contains detailed message e.g. in case of errors (failed take over, preprocessing, preflight etc.)
Values for "production_delay"
| Status code | Description |
| 0 | Normal production time |
| 10 | Delay due to production error |
| 20 | Delay due to material shortage |
| 30 | Delay due to missing warehouse items |
| 40 | Delayed shipping due to excessive outdoor temperature. |
| 50 | Delay due to internal reasons. |
Values for "provider"
| Status code | Description |
| WA | Factory pick-up |
| DHL | DHL |
| UPS | UPS |
| FDX | FedEx |
| ROYAL_MAIL | Royal Mail |
| DP | DP (Deutsche Post) |
| DPeco | DP Brief Kilotarif eco |
| DPprio | DP Brief Kilotarif prio |
| CARGO | Cargo |
| unknown | unknown |
… an others…
Values for "delivery_delay"
| Status code | Description |
| 0 | Normal delivery time |
| 10 | Warning (at least 1 day late) |
| 20 | Critical (at least 3 days late) |
| 30 | Loss (this assumes research and this status) Possible follow-up actions: Copy order and produce it again. Order is retransmitted by the client as a complaint. |
Values for DHL messages
ICE-RIC combinations:
ice_ric_kombinationen_gesamt_18022011.xls
User manual:
anwenderhandbuch_proactive_kunde_v09.pdf
en/tracking_interface.txt · Last modified: 2019/04/08 16:35 (external edit)
Page Tools
