> For the complete documentation index, see [llms.txt](https://developer.esw.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.esw.com/integrations/tracking-xml-file-spec.md). # Tracking XML File Spec Use the Tracking outbound file to receive package tracking events from ESW. ESW generates files on a schedule and drops them to SFTP. {% hint style="info" icon="file-xml" %} * The tracking event records will be supplied as a delta of the previous file. * ESW will never send the same tracking event for any package more than once. {% endhint %} ### Delta behavior * Each file contains only new tracking events since the previous file. * ESW does not send the same tracking event for the same package more than once. * Process files in sequence and persist the last processed counter. ### File naming Use this format: * `Tracking-nnnnnnnn-xxxxxxxx:xml` Where: * `nnnnnnnn:` your ESW customer number. * `xxxxxxxx`: an 8-digit, zero-padded counter starting at `00000001`. Example: `Tracking-1004-00000001.xml` ### Delivery (SFTP) * ESW provides an SFTP folder for tracking outbound files. * Agree the generation frequency with ESW (for example hourly or daily). * Each file contains records for one brand/retailer. {% hint style="warning" icon="memo-circle-check" %} ESW provides SFTP connection details (host, username, password) during onboarding. {% endhint %} ### File format rules * XML must be well-formed and encoded as UTF-8. * Root node: ``. * The file contains one `
` and one or more `` nodes. * Omit optional elements when you have no value (preferred over sending empty tags). ### Field reference #### Header
Show header fields | Element | Type | Required | Notes | | -------------- | ----------- | -------- | ---------------------------------------------------------------------------------- | | `Version` | string | Yes | File version. Always `2.05`. | | `RecordCount` | integer | Yes | Number of `` records in the file. | | `FileDateTime` | string (16) | Yes | File creation timestamp. Format: `YYYY-MM-DD HH:MM` (24-hour). | | `TimeZone` | string (3) | Yes | Timezone for `FileDateTime` (for example `UTC`). | | `FileName` | string | Yes | File name including extension. Format: `Tracking--.xml`. |
#### TrackingEvent
Show TrackingEvent fields | Element | Type | Required | Notes | | -------------------------- | ------------ | -------- | ------------------------------------------------------------------------------------------------ | | `CustomerOrderReference` | string (20) | Yes | Your order reference. | | `CustomerPackageReference` | string (20) | No | Your package reference. | | `EswOrderReference` | string (20) | No | ESW order reference. | | `EswPackageReference` | string (20) | No | ESW package reference. | | `EswReturnOrderReference` | string (20) | No | ESW return order reference (when applicable). | | `CarrierPackageReference` | string (20) | No | Carrier tracking/reference number. | | `EventCode` | string (20) | Yes | Event code from the [Event codes](#event-codes) list. | | `EventDescription` | string (100) | Yes | Human-readable event description. | | `EventDateTime` | string (16) | Yes | Tracking event timestamp. Format: `YYYY-MM-DD HH:MM` (24-hour). | | `EventLocation` | string (50) | Yes | Location in `Town/City, CC` format, where `CC` is ISO 3166-1 alpha-2 (for example `London, GB`). |
#### Example XML
Show example XML ```xml
2.05 2 2013-01-25 14:56 UTC Tracking-1004-00000001.xml
12345678901234567810 123456789012345678 5001000000001 6001000000001 200100123 12345678901234567810 ESW0000015 Shipment Delivered - J.Smith 2013-01-25 14:56 London, GB 12345678901234567811 123456789012345679 5001000000002 6001000000002 200100124 12345678901234567811 ESW0000008 Departed Origin Country 2013-01-27 17:16 New York, US ```
#### Event codes The following table shows the meaning of each `EventCode` value.
Show event codes | EventCode | Description | Short Description | | ---------- | -------------------------------------------------------------------- | -------------------------------------------------- | | ESW0000001 | Order pending ID details collection | Pending ID Details | | ESW0000002 | ID Details received or submitted by Shopper | Released - consignee Information Received | | ESW0000003 | Shipment is on hold at origin waiting for CD\&T payment | Pending Customs, Duty & Tax Payment | | ESW0000004 | Payment received or Retailer requested to release | Released - Payment received | | ESW0000005 | Shipment left the retailer warehouse | Shipped | | ESW0000006 | Shipment arrived to International forwarder at origin | Arrived International Hub | | ESW0000007 | Shipment left international forwarder and tendered to Airlines | Departed International Hub | | ESW0000008 | Shipment had departed on flight to destination country | Departed Origin Country | | ESW0000009 | Shipment arrived to the port of Destination country | Arrived at Transit Hub | | ESW0000010 | Shipment forwarded to Destination country | In Transit to Destination Country | | ESW0000011 | Shipment arrived to final destination country | Arrived Destination Country | | ESW0000012 | Shipment held in customs for check and release | Pending customs release | | ESW0000013 | Shipment customs released | Customs Released | | ESW0000014 | Shipment is out for Delivery with Driver | Out for Delivery | | ESW0000015 | Shipment Delivered/Picked up/dropped at post box/ | Delivered | | ESW0000016 | Delivery failed due to various reasons (address, Phone…) | Attempted Delivery | | ESW0000017 | Shipment returned from destination country back to port of Entry | Return to Sender | | ESW0000019 | Shipment can't be delivered due to various reasons | Undelivered | | ESW0000020 | Shipment on hold waiting for an action from Shopper or Shipper | On Hold | | ESW0000021 | Operational delay, carrier fault (Misrouted, missed delivery slot…) | Delay/Misrouted | | ESW0000022 | Delay caused by Weather, Bank Holiday, Act of God… | Uncontrollable Delay | | ESW0000023 | Shipment sent to destination under a new tracking Ref. | Redirected under a new reference | | ESW0000024 | Shipment has been sent to a different delivery address | Redirected to another destination | | ESW0000025 | General Tracking Update | General Update | | ESW0000026 | Shipment was not received at destination port or destination country | Short at Arrival | | ESW0000027 | Shipment destroyed upon shipper request | Destroyed | | ESW0000028 | Short Shipped | ASN Received - Package Missing | | ESW0000029 | Damaged - can't be delivered | Carton Arrived Damaged - Return to Vendor | | ESW0000030 | Damaged - forwarded under new packaging | Carton Arrived Damaged - Repackaged | | ESW0000031 | Shipment received, can be forwarded | Carton Arrived OK | | ESW0000032 | Delay in Line | Carton Arrived Damaged - Repackaged | | ESW0000033 | Shipment Overage | Carton Arrived - no ASN | | ESW0000034 | Shipment stopped | Carton Arrived - Stop Flag set | | ESW0000035 | Shipment stopped | Carton Arrived - Stop - Other | | ESW0000036 | Duplicate Shipment | Carton Arrived - Duplicate package | | ESW0000037 | Incorrect Address | Carton Arrived - Address failure | | ESW0000038 | Package has been labelled and ready for shipping | Package Received | | ESW0000039 | Package has been added to a Shipping Manifest | Shipment manifested (TMS) | | ESW0000040 | Shipment was scheduled for delivery upon Customer request | Shipment Scheduled for Delivery | | ESW0000041 | In Transit | In Transit | | ESW0000042 | Pending Shopper Pickup from Office (New Update) | Pending Shopper Pickup from Office (New Update) | | ESW0000043 | Package HOLD returned from HUB | Package HOLD returned from HUB | | ESW0000044 | Return Order Created | Return Order Created | | ESW0000045 | Return Order Arrived at RC | Return Order Arrived at RC | | ESW0000046 | COD Amount Collected | COD Amount Collected | | ESW0000047 | COD Amount Paid to Retailer (ESW) | COD Amount Paid to Retailer (ESW) | | ESW0000048 | Package lost | Package lost | | ESW0000049 | Package Repacked | Package Repacked | | ESW0000050 | Handed over to third party | Handed over to third party | | ESW0000051 | Return Label Created | Return Label Created | | ESW0000052 | Return Received by Carrier | Return Received by Carrier | | ESW0000053 | Return Inspected | Return Inspected | | ESW0000054 | Refund Issued | Refund Issued | | ESW0000055 | COD Amount Not Collected | COD Amount Not Collected | | ESW0000056 | Departed Hub | Departed Hub | | ESW0000057 | In Transit to Retailer | In Transit to Retailer | | ESW0000058 | Returned to Retailer | Returned to Retailer | | ESW0000060 | Package Declared | Package Declared | | ESW0000099 | No Internal Mapping | No Internal Mapping | | ESW0000601 | Delivered to RC | Delivered to RC | | ESW0000602 | Return not delivered to RC | Return not delivered to RC | | ESW0000603 | Processed in RC | Processed in RC | | ESW0000604 | Destruction by RC | Destruction by RC | | ESW0000605 | Delivered to Origin Hub | Delivered to Origin Hub | | ESW0000606 | Return not delivered to Origin Hub | Return not delivered to Origin Hub | | ESW0000607 | In Transit to Retailer | In Transit to Retailer | | ESW0000608 | Delivered to Retailer- Closure Event | Delivered to Retailer- Closure Event | | ESW0000620 | Return shipment Lost - Under investigation | Return shipment Lost - Under investigation | | ESW0000621 | Return shipment Lost - Claim submitted | Return shipment Lost - Claim submitted | | ESW0005100 | Package received in hub, awaiting Customer Data file | Package received in hub, awaiting Data file | | ESW0005101 | Customer Data file received, Package not received in HUB | Customer Data received, Package not received | | ESW0005102 | Delayed in fulfilment, truck delay | Delayed in fulfilment, truck delay | | ESW0005103 | Delayed in fulfilment, parcel not received | Delayed in fulfilment, parcel not received | | ESW0005104 | Delayed in fulfilment, ASN no package | Delayed in fulfilment, ASN no package | | ESW0005105 | Package received, awaiting Customer Data | Package received, awaiting Customer Data | | ESW0005106 | Retailer advised package will not be shipped, package not shipped | Package not shipped - Retailer request | | ESW0005107 | Retailer advised package will not be shipped, data not sent | Retailer advised package will not be shipped | | ESW0005108 | Label reserved, order not fulfilled | Label reserved, order not fulfilled | | ESW0005109 | BMO not received | BMO not received | | ESW0005110 | No BMO - Retailer to Action | No BMO - Retailer to Action | | ESW0005200 | Package not picked up by carrier | Package not picked up by carrier | | ESW0005201 | Hub Exception - On Hand in Hub | Hub Exception - On Hand in Hub | | ESW0005203 | Printed Not Manifested - Enquiry Lodged | Printed Not Manifested - Enquiry Lodged | | ESW0005204 | Pre Export Delay | Pre Export Delay | | ESW0005205 | Pre Export Issue | Pre Export Issue | | ESW0005206 | Released not Printed | Released not Printed | | ESW0005210 | Awaiting Shopper ID details | Awaiting Shopper ID details | | ESW0005211 | Package received, on hold due to stop flag activation | Package received, on hold | | ESW0005212 | Package received, MCO data error | Package received, MCO data error | | ESW0005213 | Package received, duplicate error | Package received, duplicate error | | ESW0005214 | Package recevied, address error | Package recevied, address error | | ESW0005215 | Processing delay in HUB | Processing delay in HUB | | ESW0005216 | Package recevied, address error | Package recevied, address error | | ESW0005217 | Awaiting Shopper ID details | Awaiting Shopper ID details | | ESW0005218 | Package received, duplicate error | Package received, duplicate error | | ESW0005219 | Carrier label applied, not manifested to Carrier | Carrier label applied, not manifested to Carrier | | ESW0005220 | Package manifested, scan to pallet event missing | Package manifested, scan to pallet event missing | | ESW0005221 | Error - DG flag in ASN, no DG packaging | Error - DG flag in ASN, no DG packaging | | ESW0005222 | Error - DG packaging, no DG flag in ASN | Error - DG packaging, no DG flag in ASN | | ESW0005223 | Error - DG in ASN, country not in scope | Error - DG in ASN, country not in scope | | ESW0005224 | Package not received from hub | Package not received from hub | | ESW0005225 | Package received, missing data | Package received, missing data | | ESW0005226 | Package on hold in HUB | Package on hold in HUB | | ESW0005227 | Package will not ship, military address prohibited | Package will not ship, military address prohibited | | ESW0005228 | Error - No DG Declaration | Error - No DG Declaration | | ESW0005229 | Error - quantity issue | Error - quantity issue | | ESW0005230 | HUB Exception - for Return to Sender | HUB Exception - for Return to Sender | | ESW0005231 | HUB Exception - for Return to Sender - No ID details | HUB Exception - Return to Sender - No ID details | | ESW0005232 | HUB Exception - for Return to Sender - Cannot ship | HUB Exception - for Return to Sender - Cannot ship | | ESW0005233 | HUB Exception - for Return to Sender - Military address | HUB Exception - Return to Sender-Military address | | ESW0005234 | HUB Exception - for Return to Sender - quantity issue | HUB Exception - Return to Sender - quantity issue | | ESW0005235 | HUB Exception - for Return to Sender - DG packaging issue | Return to Sender - DG packaging issue | | ESW0005236 | HUB Exception - for Return to Sender - DG ASN issue | HUB Exception - Return to Sender - DG ASN issue | | ESW0005237 | HUB Exception - for Return to Sender - Country not in scope DG | Return to Sender - Country not in scope DG | | ESW0005238 | HUB Exception - for Return to Sender - ID issue | HUB Exception - for Return to Sender - ID issue | | ESW0005239 | HUB Exception - for Return to Sender - general return | HUB Exception - Return to Sender - general return | | ESW0005240 | HUB Exception - for Return to Sender - Military address | HUB Exception - Return to Sender-Military address | | ESW0005241 | HUB Exception - for Return to Sender - quantity issue | HUB Exception - Return to Sender - quantity issue | | ESW0005242 | Fraud stop, returned to retailer | Fraud stop, returned to retailer | | ESW0005243 | MITI – Fraud Order | MITI – Fraud Order | | ESW0005301 | In Transit - Flight departed | In Transit - Flight departed | | ESW0005302 | In Transit - Flight arrived | In Transit - Flight arrived | | ESW0005303 | Transit Delay - Technical issue, 1 day delay | Transit Delay - Technical issue, 1 day delay | | ESW0005304 | Transit Delay - Technical issue, 2 day delay | Transit Delay - Technical issue, 2 day delay | | ESW0005305 | Transit Delay - Weather related issue, 1 day delay | Transit Delay - Weather related issue, 1 day delay | | ESW0005306 | Transit Delay - Weather related issue, 2 day delay | Transit Delay - Weather related issue, 2 day delay | | ESW0005307 | Transit Delay - Capacity issue, 1 day delay | Transit Delay - Capacity issue, 1 day delay | | ESW0005308 | Transit Delay - Capacity issue, 2 day delay | Transit Delay - Capacity issue, 2 day delay | | ESW0005309 | Transit Delay - Ground transport delay | Transit Delay - Ground transport delay | | ESW0005310 | Transit Delay - ESW Data Issue | Transit Delay - ESW Data Issue | | ESW0005311 | MITI – Retailer Data Issue | MITI – Retailer Data Issue | | ESW0005401 | Transit Delay - Confiscated by Customs | Transit Delay - Confiscated by Customs | | ESW0005402 | Transit Delay - Awaiting Customs clearance | Transit Delay - Awaiting Customs clearance | | ESW0005403 | Transit Delay - Customs checks | Transit Delay - Customs checks | | ESW0005404 | Transit Delay - Customs enquiry | Transit Delay - Customs enquiry | | ESW0005405 | Transit Delay - Shopper to supply information | Transit Delay - Shopper to supply information | | ESW0005406 | Transit Delay - Commercial Invoice required | Transit Delay - Commercial Invoice required | | ESW0005407 | Transit Delay - D\&T not paid | Transit Delay - D\&T not paid | | ESW0005408 | Transit Delay - Cannot contact shopper | Transit Delay - Cannot contact shopper | | ESW0005409 | Transit Delay - Pending Shopper ID | Transit Delay - Pending Shopper ID | | ESW0005410 | Transit Delay - Customs delay, expect 1 day delay | Transit Delay - Customs delay, expect 1 day delay | | ESW0005411 | Transit Delay - Customs delay, expect 2 day delay | Transit Delay - Customs delay, expect 2 day delay | | ESW0005412 | Transit Delay - Missing data for processing | Transit Delay - Missing data for processing | | ESW0005413 | Transit Delay - Formal Clearance required | Transit Delay - Formal Clearance required | | ESW0005414 | Transit Delay - Customs processing delay, Flight delay impact | Customs processing delay, Flight delay impact | | ESW0005415 | Transit Delay - Customs processing delay, COVID19 related delay | Customs processing delay, COVID19 related Delay | | ESW0005416 | Transit Delay - Customs processing delay, COVID19 related delay | Customs processing delay, COVID19 related Delay | | ESW0005417 | Transit Delay - Not injected in last mile | Transit Delay - Not injected in last mile | | ESW0005418 | LM Update - Customs Clearance confirmed | LM Update - Customs Clearance confirmed | | ESW0005419 | LM Update - Injected to network confirmed | LM Update - Injected to network confirmed | | ESW0005501 | Transit delay - Under investigation, delayed | Transit delay - Under investigation, delayed | | ESW0005502 | Transit delay - Under investigation, transit delay | Transit delay - Under investigation, transit delay | | ESW0005503 | Mistroute - Package misrouted, under investigation | Mistroute - Package misrouted, under investigation | | ESW0005504 | With Third-Party | With Third-Party | | ESW0005505 | Transit delay - Carrier Investigation ongoing | Transit delay - Carrier Investigation ongoing | | ESW0005506 | Delivered - NO POD or Third Party | Delivered - NO POD or Third Party | | ESW0005507 | Attempted Delivery | Attempted Delivery | | ESW0005508 | With Delivery Partner for delivery | With Delivery Partner for delivery | | ESW0005509 | In Transit - Data issue | In Transit - Data issue | | ESW0005510 | Transit Delay - flight-related, expect 1 day delay | Transit Delay - flight-related, expect 1 day delay | | ESW0005511 | Transit Delay - flight-related, expect 2 day delay | Transit Delay - flight-related, expect 2 day delay | | ESW0005512 | With Delivery Partner for delivery | With Delivery Partner for delivery | | ESW0005513 | Transit Issue - Manifested but not received | Transit Issue - Manifested but not received | | ESW0005514 | Transit Delay - flight delay impacting delivery | Transit Delay - flight delay impacting delivery | | ESW0005515 | Transit delay - Under investigation | Transit delay - Under investigation | | ESW0005516 | CTS General Update | CTS General Update | | ESW0005517 | Lost Package - Under investigation | Lost Package - Under investigation | | ESW0005518 | Lost Package - Claim process opened with Carrier | Lost Package - Claim process opened with Carrier | | ESW0005519 | MITI Final mile address issue | Final mile address issue | | ESW0005520 | Package at risk | Final Mile Package at risk | | ESW0005521 | MITI Last Mile - Major weather disruption | Final Mile - Major weather disruption | | ESW0005522 | MIT Last Mile - Uncontrollable Delay | Final Mile - Uncontrollable Delay | | ESW0005523 | MITI Flight Delay - Covid19 Related | Flight Delay - Covid19 Related | | ESW0005524 | MITI Pending COD payment | MITI Pending COD payment | | ESW0005525 | Package Undeliverable - Returns Initiated | Package Undeliverable - Returns Initiated | | ESW0005X01 | General transit delay, delivery delay unknown | General transit delay, delivery delay unknown | | ESW0005X02 | Transit Delay Email - up to 3 day delay | Transit Delay Email - up to 3 day delay | | ESW0005X03 | Transit Delay Email - up to 5 day delay | Transit Delay Email - up to 5 day delay | | ESW0005X04 | Transit Delay Email - up to 8 day delay | Transit Delay Email - up to 8 day delay | | ESW0005X05 | Transit Delay Email - up to 10 day delay | Transit Delay Email - up to 10 day delay | | ESW0008000 | ESW CS Service Now Ticket Received- Enquiry Lodged | ESW CS Service Now Ticket Received- Enquiry Lodged |
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developer.esw.com/integrations/tracking-xml-file-spec.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.