Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Shipwire: Inventory Response 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).
-->
<--
InventoryUpdateResponse.dtd
Copyright (C) 2014, Shipwire Inc. All rights reserved.
Last modified: 2014-04-03
-->
<!ELEMENT InventoryUpdateResponse (Status, ErrorMessage?, Product*, TotalProducts?, ProcessingTime?)>
<!--
Status: 0 indicates a successful response
-->
<!ELEMENT Status (#PCDATA)>
<!--
ErrorMessage: Text description of the reason for the error
-->
<!ELEMENT ErrorMessage (#PCDATA)>
<!--
Product: Element attributes indicate counts of stock in various states:
Inventory Availability
code: The name of the product (SKU)
quantity: Stock that is readily available to ship
good: Stock that is readily available to ship (synonym for "quantity")
pending: Stock expected to be arriving
backordered: Stock allocated to backorders
reserved: Stock allocated to orders
shipping: Stock that is now being processed by the warehouse for shipment
shipped: Stock that the warehouse has shipped previously
consuming*: Stock that is being used in a special project
creating*: Stock that is being created as a result of a special project
consumed: Stock that has been used by special projects previously
created: Stock that has been created by special projects previously
availableDate: For backordered products, the next date inventory is expected
to be available, based on pending receivings, and after all
outstanding backorders have been shipped. The value of this
field is a date in YYYY-MM-DD format (e.g. "2011-11-03").
* NOTE: In the Shipwire inventory manager, "reserved" inventory includes
"consuming" inventory counted above.
* NOTE: In the Shipwire inventory manager, "pending" inventory includes
"creating" inventory counted above.
Inventory Statistics
shipped_last_day: Quantity shipped in the previous day
shipped_last_week: Quantity shipped in the previous 7 days
shipped_last_4_weeks: Quantity shipped in the previous 28 days
ordered_last_day: Quantity ordered in the previous day
ordered_last_week: Quantity ordered in the previous 7 days
ordered_last_4_weeks: Quantity ordered in the previous 28 days
-->
<!ELEMENT Product EMPTY>
<!ATTLIST Product
code CDATA #REQUIRED
quantity CDATA #REQUIRED
pending CDATA #REQUIRED
good CDATA #REQUIRED
backordered CDATA #REQUIRED
reserved CDATA #REQUIRED
shipping CDATA #REQUIRED
shipped CDATA #REQUIRED
consuming CDATA #REQUIRED
creating CDATA #REQUIRED
consumed CDATA #REQUIRED
created CDATA #REQUIRED
availableDate CDATA #IMPLIED
shippedLastDay CDATA #REQUIRED
shippedLastWeek CDATA #REQUIRED
shippedLast4Weeks CDATA #REQUIRED
orderedLastDay CDATA #REQUIRED
orderedLastWeek CDATA #REQUIRED
orderedLast4Weeks CDATA #REQUIRED
isAlias CDATA #IMPLIED
isBundle CDATA #IMPLIED
>
<!ELEMENT TotalProducts (#PCDATA)>
<!--
Time it took to process the request (ms)
-->
<!ELEMENT ProcessingTime (#PCDATA)>
<!ATTLIST ProcessingTime
units CDATA #REQUIRED
>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.