Shipwire: Tracking Response DTD

TrackingUpdateResponse.dtd

<?xml version="1.0" encoding="UTF-8" ?>
<!--

  PLEASE NOTE:
  
  In September 2014, we launched a new RESTful API
  (see documentation at http://www.shipwire.com/developers).
  
  The new API replicates all the functionality of our legacy XML API
  while providing a foundation for future API enhancements.

  In order to focus on adding new features to the RESTful API, we are
  deprecating the legacy XML API. This means that Shipwire will continue
  to provide the legacy XML API for existing integrations, but new
  features will not be added to it.
  
  Developers of new integrations should use the RESTful API.
  
  If you already have an integration with Shipwire’s legacy API,
  migrating to the new API is recommended so you can take advantage of
  new features as we add them (see our API Roadmap).
-->

<!--

  TrackingUpdateResponse.dtd

  Copyright (C) 2014, Shipwire Inc.  All rights reserved.

  Last modified: 2014-05-04

-->

<!--
    A tracking update response contains status information for zero or more
    orders, depending on the criteria of the TrackingUpdate request.
-->
<!ELEMENT TrackingUpdateResponse (Status, Order*,
                                  TotalOrders, TotalShippedOrders, TotalProducts,
                                  ResultsLimit?, ResultsOffset?,
                                  Bookmark?, ProcessingTime?)>
<!ELEMENT Status (#PCDATA)>
<!ELEMENT Order (TrackingNumber*, Holds?, Items?, RelatedOrder*)>

<!--
    Order element attributes

    id:
        The merchant's shopping cart/commerce platform order number

    shipwireId:
        The Shipwire reference number uniquely identifying the order

    warehouse:
        The name of the warehouse from which the order has or will be shipped

    shipped:
        "YES" or "NO", depending on whether the order has been marked
        physically shipped

    shipper:
        The carrier code representing the carrier service used to ship the
        order

    shipperFullName:
        The full name of the carrier service used to ship the order

    shipDate:
        The date a tracking number was issued for the shipped order

    cancelDate:
        The date an order was cancelled, if it was cancelled

    tracked:
        "YES" or "NO", depending on whether the carrier indicates that
        any part of the shipped order is in transit.
        "UNKNOWN" for untrackable services.

    delivered:
        "YES" or "NO", depending on whether the carrier indicates that
        any part of the shipped order has been delivered.
        "UNKNOWN" for untrackable services.

    expectedDeliveryDate:
        Shipwire's estimate of the order delivery date

    handling:
        Total cost to the merchant to handle this order

    shipping:
        Total freight cost to the merchant for this order

    packaging:
        Total cost of any custom/premium packaging used for this order

    insurance:
        Total cost to the merchant to insure this order

    total:
        All-inclusive cost to the merchant to ship this order

    returned:
        "YES" or "NO", depending on whether the order has been returned

    returnDate:
        The date the order was returned

    returnCondition:
        "GOOD", "BAD", or "MIXED" depending on whether the order was returned
        in apparently salable (e.g. new, unopened) condition

    href:
        The Customer Service Portal link to review the status of and manage
        this order.  You may share this with your customers.  You must have
        the Customer Service Portal tool enabled in the application (See
        "Delight")

    affiliateStatus:
        The status of this order, for affiliate credit eligibility.  Only
        orders marked "shipwireFulfilled" are eligible for affiliate credit.

    manuallyEdited:
        "YES" or "NO", depending on whether the order has been manually
        created or edited within the Shipwire application (as opposed to
        imported from a shopping cart or other commerce platform).
-->
<!ATTLIST Order
    id CDATA #REQUIRED
    shipwireId CDATA #REQUIRED
    warehouse CDATA #IMPLIED
    shipped (YES|NO) #REQUIRED
    shipper CDATA #IMPLIED
    shipperFullName CDATA #IMPLIED
    shipDate CDATA #IMPLIED
    cancelDate CDATA #IMPLIED
    delivered (YES|NO|UNKNOWN) #IMPLIED
    expectedDeliveryDate CDATA #IMPLIED
    handling CDATA #IMPLIED
    shipping CDATA #IMPLIED
    packaging CDATA #IMPLIED
    insurance CDATA #IMPLIED
    total CDATA #IMPLIED
    returned (YES|NO) #REQUIRED
    returnDate CDATA #IMPLIED
    returnCondition (GOOD|BAD|MIXED) #IMPLIED
    href CDATA #IMPLIED
    affiliateStatus (shipwireFulfilled|canceled|held|merchantFulfilled|duplicate) #IMPLIED
    manuallyEdited (YES|NO) #IMPLIED
>

<!--
    TrackingNumber element attributes

    carrier:
        The shipment's carrier

    tracked:
        Whether the carrier has reported that the shipment is in transit.

    delivered:
        Whether the carrier has reported that the shipment has been delivered.

    summary:
        The current status of the shipment as reported by the carrier.

    summaryDate:
        The date and time at which the current summary was updated.

    trackedDate:
        Timestamp of last transit status, if the carrier is reporting that the shipment is in transit.

    deliveryDate:
        Timestamp of delivery, if the carrier is reporting that the shipment was delivered.

    href:
        URL to the carrier tracking page for this shipment, if available.
-->
<!ELEMENT TrackingNumber (#PCDATA)>
<!ATTLIST TrackingNumber
    carrier CDATA #REQUIRED
    delivered (YES|NO|UNKNOWN) #IMPLIED
    summary CDATA #IMPLIED
    summaryDate CDATA #IMPLIED
    deliveryDate CDATA #IMPLIED
    href CDATA #IMPLIED
>

<!ELEMENT Holds (Hold*)>
<!ELEMENT Hold (Date, Type, Description)>
<!ELEMENT Date (#PCDATA)>
<!ELEMENT Type (#PCDATA)>
<!ELEMENT Description (#PCDATA)>

<!--
    Order item and related data (included if IncludeItems specified)

    See OrderList.dtd for complete Item definition
-->
<!ELEMENT Items (Item*)>
<!ELEMENT Item (Code, Quantity, UnitValue?, ItemData*)>
<!ELEMENT Code (#PCDATA)>
<!ELEMENT Quantity (#PCDATA)>
<!ELEMENT UnitValue (#PCDATA)>
<!ATTLIST UnitValue
    currency CDATA #IMPLIED
>

<!--
    Item-related data (e.g. recorded serial numbers, lot numbers, etc.
-->
<!ELEMENT ItemData (#PCDATA)>
<!ATTLIST ItemData
    type (serialNumber|lotNumber|other) #REQUIRED
>

<!--
    Related orders to this order, typically returns or replacement shipments,
    along with any tracking information associated with them.
-->
<!ELEMENT RelatedOrder (TrackingNumber*)>
<!ATTLIST RelatedOrder
    type (return|undershipment|overshipment|split|parent) #REQUIRED
    shipwireId CDATA #REQUIRED
>

<!ELEMENT TotalOrders (#PCDATA)>
<!ELEMENT TotalShippedOrders (#PCDATA)>
<!ELEMENT TotalProducts (#PCDATA)>

<!-- Returned if ResultsLimit or ResultsOffset were provided in TrackingUpdate request -->
<!ELEMENT ResultsLimit (#PCDATA)>
<!ELEMENT ResultsOffset (#PCDATA)>

<!ELEMENT Bookmark (#PCDATA)>

<!--
  Time it took to process the request (ms)
-->
<!ELEMENT ProcessingTime (#PCDATA)>
<!ATTLIST ProcessingTime
    units CDATA #REQUIRED
>