Supplier Oasis API Data Model Reference: 1.

0-SNAPSHOT
This document refers to version1.0-SNAPSHOT of the SOFS API.

These materials are the exclusive property of Supplier Oasis Fulfillment Services, Inc. hereafter known as SOFS,
and constitute proprietary information of SOFS. Any duplication, copying, distribution, modification, or
transmission of the materials is strictly prohibited.

The materials are provided “as is” without any warranties of any kind including warranties of merchantability,
fitness for a particular purpose, or non-infringement. SOFS does not warrant the accuracy and completeness of
the materials and may make changes to them at any time without notice.
 API Endpoints Reference ........................................................... 7
Inventory resource ................................................................. 8
GET ............................................................................. 8
Request ........................................................................ 8
Response XSD element ............................................................ 8
GET ............................................................................. 8
Request ........................................................................ 8
Response XSD element ............................................................ 8
Sales Orders resource .............................................................. 8
GET ............................................................................. 8
Request XSD element ............................................................. 8
Response XSD element ............................................................ 8
POST............................................................................. 9
Request ........................................................................ 9
Request XSD element ............................................................. 9
Response XSD element ............................................................ 9
Shipments Resource ................................................................. 9
POST .............................................................................. 9
Request.......................................................................... 9
POST /shipments................................................................. 9
Request XSD element ............................................................. 9
Response XSD element ............................................................ 9
Top-level Elements .................................................................10
API Model Reference ................................................................11
Complex Types......................................................................11
AddressType.........................................................................11
AddressType elements ................................................................11
BrandingType ........................................................................11
BrandingType elements ................................................................11
CodeType...........................................................................12
CodeType element ...................................................................12
CurrencyType ........................................................................13
CurrencyAmountType elements ..........................................................13
CurrentInventoryMessageType ............................................................13
CurrentInventoryMessageType elements ....................................................13
CurrentInventoryQuantityDetailsType ........................................................13
CurrentInventoryQuantityDetailsType elements ................................................13
CurrentInventoryType ...................................................................14
CurrentInventoryType elements ..........................................................14
CurrentWarehouseQuantityType ...........................................................14
 CurrentWarehouseQuantityType elements ...................................................14
DimensionsType ......................................................................14
DimensionsType elements ..............................................................14
InventoryAdjustmentType ................................................................15
InventoryAdjustmentType elements ........................................................15
InventoryHistoryMessageType.............................................................15
InventoryHistoryMessageType element .....................................................15
ItemSpecialHandlingListType..............................................................16
ItemSpecialHandlingListType element ......................................................16
ItemSpecialHandlingType ................................................................16
ItemSpecialHandlingListType element ......................................................16
LTLShipmentType .....................................................................16
LTLShipmentType elements .............................................................16
LengthUnitOfMeasureType ...............................................................16
LengthUnitOfMeasureType elements .......................................................16
LightWeight0to16OzShipmentType..........................................................17
LightWeight0to16OzShipmentType elements .................................................17
LightWeightGreaterThan1LbShipment .......................................................17
LightWeightGreaterThan1LbShipmentType elements ............................................17
NonThirdPartyBillingShipmentType .........................................................18
NonThirdPartyBillingShipmentType elements .................................................18
PackageDetailType ....................................................................18
PackageDetailType elements ............................................................18
ProcessedSalesOrderLineType ............................................................18
ProcessedSalesOrderLineType elements ....................................................18
ProcessedSalesOrderMessageType.........................................................19
ProcessedSalesOrderMessageType elements ................................................19
ProcessedSalesOrderType ...............................................................20
ProcessedSalesOrderType elements .......................................................20
ProductDescriptionType .................................................................21
ProductDescriptionType elements .........................................................21
ProductUnitOfMeasureType ..............................................................21
ProductUnitOfMeasureType element .......................................................21
SalesOrderAcknowledgementMessageType ...................................................22
SalesOrderAcknowledgementMessageType element ............................................22
SalesOrderAcknowledgementResponseMessageType ............................................22
SalesOrderAcknowledgementResponseMessageType element .....................................22
SalesOrderAcknowledgementResponseType...................................................22
SalesOrderAcknowledgementResponseType elements ..........................................22
SalesOrderAcknowledgementType..........................................................22
SalesOrderAcknowledgementType elements .................................................23
SalesOrderBaseType ...................................................................23
SalesOrderBaseType elements...........................................................23
SalesOrderLineResponseType ............................................................24
SalesOrderLineResponseType elements ....................................................24
SalesOrderLineType ...................................................................24
SalesOrderLineType elements ...........................................................24
SalesOrderMessageType ................................................................25
SalesOrderMessageType elements ........................................................25
SalesOrderResponseMessageType .........................................................25
SalesOrderResponseMessageType elements .................................................25
SalesOrderResponseType ...............................................................25
SalesOrderResponseType elements .......................................................25
SalesOrderType ......................................................................25
SalesOrderType elements ..............................................................26
ShipConfirmationType ..................................................................26
ShipConfirmationType elements ..........................................................26
ShipmentDetailType....................................................................27
ShipmentDetailType elements ...........................................................27
ShippingSpecificationsType...............................................................27
ShippingSpecificationsType elements ......................................................27
ShortShipType .......................................................................28
ShortShipType elements ...............................................................28
SkuInventoryAdjustmentType .............................................................28
SkuInventoryAdjustmentType elements .....................................................28
SkuInventoryHistoryMessageType ..........................................................28
SkuInventoryHistoryMessageType elements ..................................................29
SmallParcelShipmentType ...............................................................29
SmallParcelShipmentType elements .......................................................29
SpecialHandlingCodeType ...............................................................29
SpecialHandlingCodeType elements .......................................................29
SupplierInventoryMessageType ............................................................29
SupplierInventoryMessageType elements....................................................29
SupplierInventoryResponseMessageType .....................................................30
SupplierInventoryResponseMessageType elements.............................................30
SupplierInventoryResponseType ...........................................................30
SupplierInventoryResponseType elements ...................................................30
SupplierInventoryType ..................................................................30
 SupplierInventoryType elements ..........................................................30
SupplierShipConfirmationType.............................................................30
SupplierInventoryType elements ..........................................................31
SupplierShipmentMessageType............................................................31
SupplierShipmentMessageType element ....................................................31
SupplierShipmentResponseMessageType.....................................................31
SupplierShipmentResponseMessageType elements ............................................31
SupplierShipmentResponseType ...........................................................31
SupplierShipmentResponseType elements ...................................................31
SupplierShipmentType ..................................................................32
SupplierShipmentType elements ..........................................................32
SupplierWarehouseQuantityResponseType ....................................................32
SupplierWarehouseQuantityResponseType elements ...........................................32
SupplierWarehouseQuantityType ...........................................................33
SupplierWarehouseQuantityType elements...................................................33
ThirdPartyBillingShipmentType ............................................................33
ThirdPartyBillingShipmentType elements ....................................................33
WarehouseInventoryAdjustmentType ........................................................33
WarehouseInventoryAdjustmentType elements ................................................33
WeightType .........................................................................34
WeightType elements .................................................................34
WeightUnitOfMeasureType ...............................................................34
WeightUnitOfMeasureType element .......................................................34
Simple Types ........................................................................34
AbsoluteQuantityType ..................................................................34
AbsoluteQuantityType element ...........................................................34
CodeSimpleType ......................................................................34
CodeSimpleType - A string that contains a coded value. ..........................................35
CurrencyCodeType ....................................................................35
CurrencyCodeType values ..............................................................35
CurrencyCodeType ....................................................................35
CurrencyCodeType - A type that is based on CodeSimpleType .....................................35
DispositionType.......................................................................35
DispositionType .....................................................................35
LengthType..........................................................................35
MoneyType element ..................................................................36
MoneyType..........................................................................36
MoneyType element ..................................................................36
OrderFulfillmentType ...................................................................36
 OrderFulfillmentType values .............................................................36
ReasonCode.........................................................................36
ReceiptStatusType values ..............................................................36
ReceiptStatus ........................................................................37
ReceiptStatusType values ..............................................................37
SalesOrderLineCancelReasonType .........................................................37
SalesOrderLineCancelReasonType values ...................................................37
SalesOrderLineStatusType ...............................................................37
SalesOrderLineStatusType values.........................................................37
SalesOrderStatusType ..................................................................38
SalesOrderStatusType values............................................................38
ShipmentStatusType ...................................................................38
ShipmentStatusType values .............................................................38
XSD’s .............................................................................39
BatchJob XSD: ......................................................................39
Common Types XSD: .................................................................40
InventoryUpdate XSD: .................................................................44
SalesOrder XSD: ....................................................................50

API Endpoints Reference

Endpoints exposed by the API are Inventory, SalesOrders, Shipments, and Warehouses. The
reference lists the methods that are supported, together with their asso ciated parameters
and elements.

Because the Accept and Content Type headers are commonly understood, they are not
documented repeatedly. Please note the following:

• Content Type options for inventory calls are CSV, XML, and text.

• Content Type options for the shipments calls are XML and text.

• Content Type options for sales order calls are XML and CSV.

Most of the HTTP methods require startTime and endTime query parameters, which must
conform to the W3C recommendation in section 3.2.7 at http://www.w3.org/TR/xmlschema-
2/#dateTime

Examples are:

• startTime=2013-08-01.

• startTime=2013-08-01&endTime=2013-08-02

• startTime=2013-08-01T00:00:00&endTime=2013-08-02T12:00:00

The endTime query parameter is optional with a default value of "now."

Inventory resource
/inventory

GET
Handles the HTTP GET action for inventory, to get current statuses for inventory items.

Request
GET /inventory

Response XSD element

currentInventoryMessage of type, CurrentInventoryMessageType

GET
Handles the HTTP GET action for a history of changes to the inventory.

Request
GET /inventory/history

Response XSD element

inventoryHistory of type, InventoryHistoryMessageType

Sales Orders resource

/salesorders

GET
Handles the HTTP GET action for all processed sales orders that were created or modified
within a specified date range. Use this call to track newly created orders and to check
fulfillment activity on existing orders.

Request XSD element

processedSalesOrdersMessage of type, ProcessedSalesOrderMessageType

GET /salesorders?starttime=datetime&endtime=datetime

Response XSD element

processedSalesOrdersMessage of type, ProcessedSalesOrderMessageType
POST
Handles the HTTP POST action for creating a sales order for a SOFS warehouse.

Request
POST /salesorders

Request XSD element

salesOrderMessage of type, SalesOrderMessageType

Response XSD element

salesOrderResponseMessage of type, SalesOrderResponseMessageType

Shipments Resource
/shipments

POST
Handles the HTTP POST action for creating a shipment confirmation or a short shipment.

Request
POST /shipments

Request XSD element

supplierShipmentMessage of type, SupplierShipmentMessageType

Response XSD element

supplierShipmentResponseMessage of type, SupplierShipmentResponseMessageType
 Top-level Elements
The following list contains the top-level elements in the SOFS XSD.

• currentInventoryMessage of type, CurrentInventoryMessageType

• inventoryHistory of type, InventoryHistoryMessageType

• processedSalesOrderMessage of type, ProcessedSalesOrderMessageType

• salesOrderAcknowledgementMessage of type, SalesOrderAcknowledg ementMessageType

• salesOrderAcknowledgementResponseMessage of type,
SalesOrderAcknowledgementResponseMessageType

• salesOrderMessage of type, SalesOrderMessageType

• salesOrderResponseMessage of type, SalesOrderResponseMessageType

• skuInventoryHistory of type, SkuInventoryHistoryType

• supplierInventoryMessage of type, SupplierInventoryMessageType

• supplierInventoryResponseMessage of type, SupplierInventoryResponseMessageType

• supplierShipmentMessage of type, SupplierShipmentMessageType

• supplierShipmentResponseMessage of type, SupplierShipmentResponseMessageType

• salesChannelName of type, string

• shipperOfRecordAccountNumber of type, string

• salesChannelOrderNumber of type, string

• salesChannelLineId of type, long

• shippingServiceLevel of type, CodeType

• retailOrderNumber of type, string

• salesChannelLineNumber of type, long

• uspsMailerId of type, string

• warehouseName of type, CodeType

• billingAccountNumber of type, string

• retailChannelCode of type, string

• retailerOrderCode of type, string

• carrier of type, Codetype

API Model Reference
This chapter identifies the complex types and the simple types. Required elements are
indicated by an asterisk
(*).

Complex Types
Complex types are listed alphabetically.

AddressType
A complex type that describes a physical location.

AddressType elements
Name Type Description
*contactName string Name of person associated with this address
*address1 string First line of the address
address2 string Additional line for the address
address3 string Another optional line for the address
district string Name of the district for the address
*city string Name of the city
*stateOrProvince string Name of the state
*postalCode string USPS zip code; five or nine digits are supported.
*country code CountryCodeType ISO 3166-1 alpha-3 country code
*phoneNumber string Phone number
alternatePhone string Additional alternate phone number
email string Email address associated with the address

BrandingType
Company information that could be included in a parcel that is delivered to a customer.

BrandingType elements
Name Type Description
packingSlipPromoText string Promotional text for the sales channel that appears on the
packing slip

returnPolicyText string Return policy to be printed on the packing slip; should be

present if the order is either off-network or whitelabel

Name Type Description

brand CodeType Code for the branding of the order

CodeType
A CodeType contains an xs:string that resolves to a code. Codes are used as abbreviations of longer names. For
example, a state code of CA represents California. The intent of the code is to allow systems to process based on a
known set of values. Typically, these values are fairly static but occasionally might change. For Supplier Oasis, the code
list for a particular type is available on the Supplier Oasis API Website.

CodeType element
Name Type Description

*code string Abbreviated representation of a longer name

CurrencyType
A type to denote currency

CurrencyAmountType elements
Name Type Description

amount CurrencyAmountType Amount of money in currency code denominations

currencyCode CurrencyCodeType Type of currency denomination; default value is USD.

CurrentInventoryMessageType
Defines the current inventory for a set of products (SKUs) at each warehouse.

CurrentInventoryMessageType elements
Name Type Description
currentInventory CurrentInventoryType Current inventory for a set of products
(SKUs)

CurrentInventoryQuantityDetailsType
The breakdown of specific types of inventory for an item.

CurrentInventoryQuantityDetailsType elements
Name Type Description
totalQuantity AbsoluteQuantityType Total quantity that physically resides at a warehouse; the
sum of all provided specific quantities
Name Type Description
reserved AbsoluteQuantityType Quantity that has been reserved for sales orders; a
product is in this state after a sales order is received but
has not yet shipped.
sellable AbsoluteQuantityType Quantity that is available for sale
onHold AbsoluteQuantityType Quantity that is temporarily flagged by the warehouse as
not sellable or reserved; this state may be used to
identify damaged goods.
CurrentInventoryType
Current inventory for a specific product at multiple warehouses.

CurrentInventoryType elements
Name Type Description
productDescription ProductDescriptionType Collection of attributes that describes a
product
currentWarehouseQuantity CurrentWarehouseQuantityType Quantity of a product in a warehouse

CurrentWarehouseQuantityType
The quantities of a product at a selected warehouse.

CurrentWarehouseQuantityType elements
Name Type Description
warehouseName CodeType Mnemonic identifier for a SOFS
warehouse
barcode string Scannable label of code that represents
the contents of the box

*currentInventoryQuantityDetail sCurrentInventoryQuantityDetailsType Collection of attributes that describes

current inventory

DimensionsType
Represents the physical dimensions for the length, width, and height of a container.

DimensionsType elements
Name Type Description

*length decimal Length of individual item provided by partner; four digits

of precision, expressed in lengthUnitOfMeasure

*lengthUnitOfMeasure LengthUnitOfMeasureType Unit of measure that applies to the length

Name Type Description

*width LengthType Width of the individual item provided by partner; four

digits of precision, expressed in the widthUnitOfMeasure

*widthUnitOfMeasure LengthUnitOfMeasureType Unit of measure that applies to the width

*height LengthType Height of the individual item provided by partner; four

digits of precision, expressed in the heightUnitOfMeasure

*heightUnitOfMeasure LengthUnitOfMeasureType Unit of measure that applies to the height

InventoryAdjustmentType
An adjustment to the quantity of a product at a specific warehouse.

InventoryAdjustmentType elements
Name Type Description
productDescription ProductDescriptionType Collection of attributes that describe
an item in a warehouse
warehouseInventoryAdjustment WarehouseInventoryAdjustmentType Adjustments to inventory at a
warehouse

InventoryHistoryMessageType
Defines a history of inventory changes to a product; changes may be positive or negative.

InventoryHistoryMessageType element
Name Type Description

inventoryAdjustment InventoryAdjustmentType A message that contains one or more inventory

adjustments
ItemSpecialHandlingListType
A wrapper for the ItemSpecialHandlingType in case there are multiple special handling codes. The list type will be
returned every time but might have zero to N results.

ItemSpecialHandlingListType element
Name Type Description
itemSpecialHandling ItemSpecialHandlingType Type that defines the basic data for itemSpecialHandling
code

ItemSpecialHandlingType
Defines the basic data for item special handling code.

ItemSpecialHandlingListType element
Name Type Description
*warehouseName string Mnemonic identifier for the warehouse fulfilling the sales
order

specialHandlingCode string A special handling code for this item at the warehouse

LTLShipmentType
Shipment details that apply to LTL shipping solutions.

LTLShipmentType elements
Name Type Description
freightPayorAddress AddressType Address of the payor of the freight
ltlServiceLevel CodeType Level of service for this LTL shipment (Curbside, White
Glove, etc.)
carrierNotes string Optional notes for the Carrier
carrier CodeType Code that identifies the Carrier

LengthUnitOfMeasureType
Java class for the LengthUnitOfMeasureType complex type.

LengthUnitOfMeasureType elements
Name Type Description
*code string Code for the unit of measure
LightWeight0to16OzShipmentType
Shipment details for packages weighing less than 1 lb.

LightWeight0to16OzShipmentType elements
Name Type Description

shippingServiceLevel CodeType Shipping service level for shipment of the order; if not
specified, Ground or Basic service is assumed.

shipperOfRecordAccountN umberstring Partner's identifying account number with the carrier; not
necessarily the same as the shipping account number
used for billing

carrier CodeType Code that identifies the Carrier

uspsMailerId string Mailer ID defined by USPS; required for UPSMI, FedEx

Smartpost, UPS Surepost, DHL Global Mail, and USPS

LightWeightGreaterThan1LbShipment
Shipment details that apply to lightweight shipping solutions for packages from 1 to 8 lbs.

LightWeightGreaterThan1LbShipmentType elements
Name Type Description
shippingServiceLevel CodeType Shipping service level for shipment of the order; if not
specified, Ground or Basic service is assumed.
shipperOfRecordAccountN umberstring Partner's identifying account number with the carrier;
not necessarily the same as the shipping account
number used for billing
Name Type Description

carrier CodeType Code that identifies the Carrier

uspsMailerId string Mailer ID defined by USPS; required for UPSMI, FedEx,
Smartpost, UPS, Surepost, DHL, Global Mail, and
USPS
NonThirdPartyBillingShipmentType
Designation of the carrier to ship this order.

NonThirdPartyBillingShipmentType elements
Name Type Description

*shippingServiceLevel CodeType Shipping service level for shipment of the order; if not
specified, Ground or Basic service is assumed.

*carrier CodeType Carrier that the order ships with

*billingAccountNumber string Numerical identifier of the account to be billed

PackageDetailType
Java class for the PackageDetailType complex type.

PackageDetailType elements
Name Type Description
*packageID long SOFS identifier for shipment package
*packageType CodeType Code for the type of package
*packageNumber long Package n of the total in a shipment
packageWeight double Weight of package as displayed on the label
packageWeightUnitOfMeasure CodeType Code for the unit of measure for the package weight
trackingNumber string Carrier tracking number for this package

ProcessedSalesOrderLineType
Contains information about a sales order line that has been processed by SOFS.

ProcessedSalesOrderLineType elements
Name Type Description
salesChannelLineNumber long External sales order line number, as entered in
the sales channel's system
*partnerSku string Partner's unique identifier for the order line
item
barcode string Label of machine-scannable code with
corresponding numerals that represents the
contents of the box
Name Type Description
*salesChannelSKU string SKU for this merchandise as known by the
sales channel; prints on the packing slip
*quantity long Total numeric count
specialHandling CodeType Code defining outbound special handling
for this order line; a legacy field replaced by
specialHandlingCode
giftWrapText string Text applied to the card that accompanies gift
wrapping
itemPrice decimal Dollar amount of an item
specialHandlingCode SpecialHandlingCodeType Code defining outbound special handling for
this order line
lineId long Supplier Oasis primary key for sales order line
itemId long Supplier Oasis identifier for the item on this line

itemName string Name of the item

lineStatus SalesOrderLineStatusType Status of this line only

cancelReason SalesOrderLineCancelReasonType Reason that a line was cancelled (short
shipped; null for lines that are not in
CANCELLED status.
unitCost MoneyType Unit cost for the item on this order line.
Reserved for future use; no current
functionality.
unitCostCurrencyCode CurrencyCodeType Currency code for unit cost; default is USD.
shipConfirmationDetail ShipConfirmationType Relates to one package for one order line
firstCost MoneyType Price that the Retailer pays to the Supplier

firstCostCurrenyCode CurrencyCodeType Currency code for firstCost; default is USD.

additionalShippingCost MoneyType Additional cost for expedited shipping
additionalShippingCostCur rencyCodeCurrencyCodeType Currency code for additionalShippingCost;
default is USD.
*notes string Information about the orderline

ProcessedSalesOrderMessageType
Message containing one or more processed sales orders; message flows from SOFS to the partner.

ProcessedSalesOrderMessageType elements
Name Type Description
processedSalesOrder ProcessedSalesOrderType Information about a sales order that exists in the Supplier
Oasis network; includes basic identifying information and
one or more sales order lines.

ProcessedSalesOrderType
Collection of attributes that describe a sales order that has been created in SOFS; it includes basic identifying information
and one or more sales orderlines.

ProcessedSalesOrderType elements
Name Type Description

salesChannelOrderNumber string External sales order number as entered in the sales

channel's system

*salesChannelName string Mnemonic identifier for the retailer.

orderDate dateTime Date that the order was placed

sofsCreatedDate dateTime Date that the order was created in SOFS

*warehouseName string Mnemonic identifier for the warehouse fulfilling the

order

customerId string Identifier for the customer; for example, username

customerAddress AddressType Recipient address for this order; phone number is

required for export.

*shipToAddress AddressType Recipient address for this order; phone number is

required for export.

*returnAddress AddressType Return address for this order; prints on packing

slip/shipping label. Required for off-network orders.

shippingSpecifications ShippingSpecificationsType Specific limits and conditions applied to the shipping

of parcel

branding BrandingType Promotional text for the sales channel to appear on

the packing slip

*orderFulfillment OrderFulfillmentType How to fulfill the order; e.g., whether partial

fulfillment is allowed.

orderTotal CurrencyType Total amount of the order

shippingTotal CurrencyType Total shipping amount of the order

*orderId long SOFS' unique identifier for the sales order

SalesOrderStatusType string Status of the order as a whole within the Supplier

Oasis network

retailChannelCode string Unique identifier for the retail channel

retailOrderCode string Retail order numbers are not guaranteed to be

unique for a retailer. This is an additional field that
can be passed from the retailer to distinguish an
order, if the order number is non-unique.

retailOrderNumber string Unique number on the retail channel for this order

actionRequired boolean Whether further action is required to complete

processing of the order.

Name Type Description

*processedSalesOrderLine ProcessedSalesOrderLineType

ProductDescriptionType
Description of a product that has inventory.

ProductDescriptionType elements
Name Type Description
partnerSku string Partner-defined SKU for the product
productUnitOfMeasure ProductUnitOfMeasureType Unit of measure for this product

ProductUnitOfMeasureType
Code that indicates the unit of measure for a product. Examples may include EA (Each), BX (Box).

ProductUnitOfMeasureType element
Name Type Description
*code string Code for the unit of measure for a product
SalesOrderAcknowledgementMessageType
Message that contains information about sales order(s) being acknowledged by the Supplier; this data flows from the
Supplier to SOFS.

SalesOrderAcknowledgementMessageType element
Name Type Description

salesOrderAcknowledgeme ntsalesOrderAcknowledgementTypeInformation about a sales order being acknowledged

to the Supplier Oasis network. Includes basic identifying
information and one or more sales orders.

SalesOrderAcknowledgementResponseMessa
geType
Type that indicates errors encountered while processing the salesOrderAcknowledgementMessage; this data flows from
SOFS to the Supplier.

SalesOrderAcknowledgementResponseMessageType element
Name Type Description
salesOrderAcknowledgeme ntResponseSalesOrderAcknowledgementResponseTypeMessage about errors
encountered while processing a
salesOrderAcknowledgementMessage

SalesOrderAcknowledgementResponseType
Type that indicates errors encountered while processing the salesOrderAcknowledgementMessage; this data flows from
SOFS to the Supplier.

SalesOrderAcknowledgementResponseType elements
Name Type Description
salesChannelName string Mnemonic identifier for the retailer.
salesChannelOrderNumber string External sales order number, as entered in the sales
channel's system.
acknowledgementResponse CodeCodeType TBD

SalesOrderAcknowledgementType
Information about a sales order being acknowledged to the Supplier Oasis network. Includes basic identifying information
and one or more sales orders; this data flows from the Supplier to SOFS.
SalesOrderAcknowledgementType elements
Name Type Description
*salesChannelOrderNumbe rstring External sales order number, as entered in the sales
channel's system.
*salesChannelName string Mnemonic identifier for the retailer.

SalesOrderBaseType
Java class for the SalesOrderBaseType complex type.

SalesOrderBaseType elements
Name Type Description
salesChannelOrderNumber string External sales order number as entered in the sales
channel's system
salesChannelName string Mnemonic identifier for the retailer
*orderDate dateTime Date that the order was placed

sofsCreatedDate dateTime Date that the order was created in SOFS

*warehouseName string Mnemonic identifier for the warehouse fulfilling the
sales order
*customerId string Identifier for the customer; for example, username.

customerAddress AddressType Recipient address for this order; phone number is

required for export
*shipToAddress AddressType Recipient address for this order; phone number is
required for export
*returnAddress AddressType Return address for this order, which prints on
packing slip/shipping label; required for offnetwork
orders
shippingSpecifications ShippingSpecificationsType How to fulfill the order; e.g., whether partial
fulfillment is allowed.
branding BrandingType Promotional text for the sales channel that appears
on the packing slip
*orderFulfillment orderFulfillmentType How to fulfill the order; e.g., whether partial
fulfillment is allowed.
totalValue CurrencyType Total value of the order
totalValuePaid CurrencyType Total value of the order, less any credits; the actual
amount the customer is charged.
Name Type Description
shippingTotal CurrencyType Total shipping amount of the order
SalesOrderLineResponseType
Java class for the SalesOrderLineResponseType complex type; this data flows from SOFS to the Supplier.

SalesOrderLineResponseType elements
Name Type Description
salesChannelName string Mnemonic identifier for the sales channel
salesChannelLineNumber long External sales order line number as entered in
the sales channel's system
salesChannelOrderNumber string External sales order number as entered in the
sales channel's system
salesOrderlineResponseCode CodeType Code for the sales order line response

SalesOrderLineType
Defines the basic data for a single line on a sales order.

SalesOrderLineType elements
Name Type Description
*salesChannneLineNumber long External sales order line number, as entered in the sales
channel's system
PartnerSKU string Partner's unique identifier for the merchandise
represented by this order line.
barcode string An optional field to indicate a barcode for this item that
may be different than the SKU
salesChannelSKU string SKU for this merchandise as known by the sales channel;
prints on the packing slip.
*quantity long Number of units ordered on this order line
specialHandling CodeType Replaced by specialHandlingCode.
giftWrapText string Text to put on gift wrapping card
itemPrice MoneyType Unit price for the item on this order line; required for export
only.
*itemPriceCurrencyCode CurrencyCodeType Currency code for the itemPrice
vatRate decimal VAT rate for this item
specialHandlingCode CodeType Codes defining outbound special handling for this order
line
SalesOrderMessageType
Message containing one or more sales orders being submitted; data flows from a partner to SOFS.

SalesOrderMessageType elements
Name Type Description
salesOrder SalesOrderType Information about a sales order submitted to SOFS that
includes basic identifying information and one or more
sales order lines

SalesOrderResponseMessageType
Type to indicate errors encountered while processing the salesOrderMessage.

SalesOrderResponseMessageType elements
Name Type Description
*salesOrderResponse SalesOrderResponseType Details about the error.

SalesOrderResponseType
SOFS acknowledgement that an order has been received; this data flows from SOFS to the Supplier.

SalesOrderResponseType elements
Name Type Description

*salesChannelName string Mnemonic identifier for the sales channel

*salesChannelOrderNumber string External sales order number, as entered in the sales
channel's system
*salesOrderResponseCode CodeType Code for the response
*salesOrderLineResponse SalesOrderLineResponseTy peMessage that can provide details if an error
occurred.

SalesOrderType
Information about a sales order being submitted to the Supplier Oasis network that includes basic identifying information
and one or more sales order lines.
SalesOrderType elements
Name Type Description

id long Sales order ID

salesChannelName string Mnemonic identifier for the retailer.
supplier string Name of the supplier
*salesChannelOrderNumber string Alphanumeric identifier for a sales channel
order
*transactionDate dateTime Date and time that the order was submitted by
the consumer
*warehouse string Mnemonic identifier for a SOFS warehouse
Name Type Description
*shipToAddress AddressType Address of the physical location that receives
the order
*returnAddress AddressType Address of the designated warehouse that
receives returns
*shippingSpecifications ShippingSpecificationsType Specific limits and conditions applied to the
shipping of a parcel
*branding BrandingType Promotional text for the sales channel that
appears on the packing slip
*lines SalesOrderLineType Lines in a sales order
retailChannelId

buyerId string Identifier for the buyer; for example, username.

buyerAddress AddressType Recipient address for this order; phone number

is required for export.
totalValue CurrencyType Total value of the order

totalValuePaid CurrencyType Total value of the order, less any credits. This is
the actual amount the customer is charged.
shippingTotal CurrencyType Total shipping amount of the order

ShipConfirmationType
Java class for ShipConfirmationType complex type.

ShipConfirmationType elements
Name Type Description
*quantityShipped long Sales order line quantity shipped in this package
*packageDetail PackageDetailType Details that describe the package an order shipped in
*shipmentDetail ShipmentDetailType Details of a shipment confirmation

ShipmentDetailType
Java class for ShipmentDetailType complex type.

ShipmentDetailType elements
Name Type Description

*shipmentID long Supplier Oasis primary key for shipment

shipmentCarrier string Carrier for this shipment

billOfLadingNumber string Bill of Lading number for LTL shipments

billingAccountNumber string Freight account number used for billing the shipment

shippingServiceLevel CodeType Service level for shipment of the order; if not specified,
Ground or Basic service is assumed

Name Type Description

carrierReferenceNumber string Carrier reference for LTL shipments

*dateShipped dateTime Date of shipment

dateConfirmed dateTime Date that the shipment was confirmed as shipped

supplierInvoiceNumber string Supplier's invoice number to link to Retailer's order line

*warehouseName string Nmemonic identifier for a SOFS warehouse

ShippingSpecificationsType
Java class for ShippingSpecificationsType complex type.

ShippingSpecificationsType elements
Name Type Description
*isThirdPartyBilling boolean Whether billing third party billing on your sales
channel
isSignatureRequired boolean whether a signature is required; if blank, then
FALSE is assumed
isDeclaredValueRequired boolean whether a declared value is required for this sales
order; if TRUE, then warehouse calculates from
replacement cost. If blank, FALSE is assumed.
transportationTerms string Applies to export; trade terms that apply to the
shipment
ltlShipment LTLShipmentType LTL shipment information
smallParcelShipment SmallParcelShipmentType Small parcel shipment information

lightweight0to16OzShipme ntLightweight0to16OzShipme ntTypeLightweight parcel (less than one pound)

shipment
information
lightWeightGreaterThan1L bShipmentLightWeightGreaterThan1LbShipmLightweight parcel (1-8 lbs.) shipment
informationntType
isExport boolean Indicates whether the order is for export. Required
as TRUE for .APO/FPO. If blank, FALSE is
assumed.

ShortShipType
Java class for the ShortShipType complex type

ShortShipType elements
Name Type Description
reasonCode CodeType Code for the reason for a short ship

SkuInventoryAdjustmentType
Adjustments to quantities for a specific product at multiple warehouses.

SkuInventoryAdjustmentType elements
Name Type Description

productDescription ProductDescriptionType Details that describe a

product
warehouseInventoryAdjustment WarehouseInventoryAdjustmentType Adjustment to inventory at
a warehouse

SkuInventoryHistoryMessageType
A message containing inventory adjustments to a specific SKU across multiple warehouses.
SkuInventoryHistoryMessageType elements
Name Type Description

SkuInventoryAdjustment SkuInventoryAdjustmentType Adjustment to a SKU

SmallParcelShipmentType
Shipment details that apply to parcel shipping solutions such as UPS and FedEx.

SmallParcelShipmentType elements
Name Type Description
shippingServiceLevel CodeType Code for the shipping service level
billingAccountNumber string Account number used for billing this shipment
shipperOfRecordAccountNumber string Partner's identifying account number with the carrier; not
necessarily the same as the shipping account number
used for billing
carrier CodeType Carrier used to ship the order

uspsMailerId string Mailer ID defined by USPS; required for UPSMI, FedEx

Smartpost,UPS Surepost, DHL Global Mail, and USPS.

SpecialHandlingCodeType
Defines the basic data for special handling code.

SpecialHandlingCodeType elements
Name Type Description

*specialHandlingCode CodeType Special handling code for this salesorder line.

SupplierInventoryMessageType
Inventory create or update requests that a Supplier sends to SOFS.

SupplierInventoryMessageType elements
Name Type Description

supplierInventory SupplierInventoryType A Supplier-to-SOFS inventory update request.

SupplierInventoryResponseMessageType
Response message back to the Supplier after SOFS receives the Supplier's inventory create/update requests; again, data
flows from SOFS to the Supplier.

SupplierInventoryResponseMessageType elements
Name Type Description
successCount int Total successful inventory create/update
messages received by SOFS
errorCount int Total inventory create/update requests
that failed
supplierInventoryResponse SupplierInventoryResponseType SOFS response to Supplier's inventory
updates

SupplierInventoryResponseType
Defines an inventory create/update response for one partner SKU; this data flows from SOFS to the Supplier.

SupplierInventoryResponseType elements
Name Type Description
partnerSku string Partner's unique
identifier for the item
supplierWarehouseQuantityResponse SupplierWarehouseQuantityResponseType Quantity response from
a Supplier warehouse

SupplierInventoryType
Java class for the SupplierInventoryType complex type.

SupplierInventoryType elements
Name Type Description
partnerSku string Partner's SKU for the inventory update
supplierWarehouseQuantity SupplierWarehouseQuantityType Quantity of a specific SKU in a Supplier
warehouse

SupplierShipConfirmationType
Java class for the SupplierShipConfirmationType complex type.
SupplierInventoryType elements
Name Type Description

*quantity integer Quantity shipped

*carrier CodeType Carrier used to ship confirm
*trackingNumber string Carrier tracking number for the shipment
*shipDate dateTime Date the order was shipped
serviceLevel CodeType Service level of the shipment
supplierInvoiceNumber string Supplier's invoice number to link to Retailer's order line

SupplierShipmentMessageType
Java class for the SupplierShipmentMessageType complex type.

SupplierShipmentMessageType element
Name Type Description
supplierShipment SupplierShipmentType Shipment information from a Supplier warehouse.

SupplierShipmentResponseMessageType
Java class for the SupplierShipmentResponseMessageType complex type; this data flows from SOFS to the Supplier.

SupplierShipmentResponseMessageType elements
Name Type Description

*successCount int Number of Supplier shipments

processed successfully
*errorCount int Number of Supplier shipments with
errors
*supplierShipmentResponse SupplierShipmentResponseType List of responses for each shipment

SupplierShipmentResponseType
Java class for the SupplierShipmentResponseType complex type; this data flows from SOFS to the Supplier.

SupplierShipmentResponseType elements
Name Type Description
*success boolean Indicates whether Supplier shipment was successfully
processed
Name Type Description
errorCode CodeType Code for the error
supplierShipment SupplierShipmentType Order fulfillment/shipment information from a Supplier
warehouse

SupplierShipmentType
Java class for shipment information from a Supplier warehouse.

SupplierShipmentType elements
Name Type Description

*supplierSku string The supplier SKU shipped

*salesChannelName string Mnemonic identifier for the retailer
salesChannelOrderNumber string External sales order number as entered in the
sales channel's system
retailOrderNumber string Retailer-specific order number that the customer
gets on checkout
*salesChannelLineNumber long External sales order line number, as entered in
the sales channel's system
*warehouse CodeType Unique identifier for the warehouse

*supplierShipConfirmation SupplierShipConfirmationType Ship confirmation from Supplier warehouse

*shortShip ShortShipType Orderline fulfillment cancellation due to
insufficient inventory
salesOrderAcknowedgeMessa geSalesOrderAcknowledgeMessageTypeMessage about a sales order being
acknowledged by the Supplier.

SupplierWarehouseQuantityResponseType
Defines an inventory create/update response; this data flows from SOFS to the Supplier.

SupplierWarehouseQuantityResponseType elements
Name Type Description
success boolean Indicates whether the create/update request
succeeded
message string Error or other message

supplierWarehouseQuantity SupplierWarehouseQuantityType Original single inventory create/update

request
SupplierWarehouseQuantityType
Java class for the SupplierWarehouseQuantityType complex type.

SupplierWarehouseQuantityType elements
Name Type Description
warehouseName string Mnemonic identifier for the warehouse
*quantity AbsoluteQuantityT ypeThe new quantity
timestamp dateTime Timestamp for the quantity
barcode string Required only if the barcode for this item is different from the SKU

ThirdPartyBillingShipmentType
Java class for the ThirdPartyBillingShipmentType complex type.

ThirdPartyBillingShipmentType elements
Name Type Description
*shippingServicelevel anyType Designation of carrier for this order
*billingAccountNumber string Account number used for billing this shipment

WarehouseInventoryAdjustmentType
A quantity adjustment at a specific warehouse.

WarehouseInventoryAdjustmentType elements
Name Type Description
*warehouseName string Mnemonic identifier for the warehouse
barcode string Required only if the barcode for this item is different from
the SKU
*quantity long Adjustment to inventory, either positive or negative.
reasonCode CodeType Reason for this adjustment; reason codes and
descriptions are provided by the SOFS API.
adjustmentDate dateTime Date that the inventory adjustment was processed
WeightType
Java class for the WeightType complex type.

WeightType elements
Name Type Description

*weight decimal Weight of the individual item provided by the partner.

Four digits of precision; expressed weightUnitOfMeasure.

Name Type Description

*weightUnitOfMeasure WeightUnitOfMeasureType Unit of measure applied to the weight.

WeightUnitOfMeasureType
Code for the unit of measure for weight, based on the CodeType.

WeightUnitOfMeasureType element
Name Type Description
*code string Unit of measure for weight

Simple Types
Types are listed alphabetically.

AbsoluteQuantityType
A definition of a quantity that cannot be less than zero.

AbsoluteQuantityType element
Name Type Description
Quantity long A quantity that cannot be less than zero.

CodeSimpleType
A CodeType is an xs:string which contains a coded value. The intent of the code is to allow systems to process based on
a known set of values. Typically, these values are fairly static but might occasionally change. For Supplier Oasis, the code
list for a particular type will be made available on the Supplier Oasis web site.
CodeSimpleType - A string that contains a coded value.
Name Type Description

coded value string TBD

CurrencyCodeType
Currencies are identified by their ISO 4217 currency codes. See http://www.iso.org/iso/en/prods-services/popstds/
currencycodes.html for a table of currency codes.

CurrencyCodeType values
Name Type Description
USD string US Dollar; default value
Name Type Description
CNY string Chinese yuan

CurrencyCodeType
Currencies are identified by their ISO 4217 currency codes. See http://www.iso.org/iso/en/prods-services/popstds/
currencycodes.html for a table of currency codes.

CurrencyCodeType - A type that is based on CodeSimpleType

Name Type Description

Restriction base: decimal fractionDigits value = 2 Supported types: USD (default) and CNY.

DispositionType
Disposition of a returned item, expressed as a status.

DispositionType
Name Type Description
LIQUIDATE string Item is liquidated.
RESTOCK string Item is to be restocked.
WAREHOUSE string Item is in warehouse.

DESTROY_IN_FIELD string Item is destroyed.

LengthType
Java class for the LengthType simple type.
MoneyType element
Name Type Description

restriction base fractionDigits totalDigits value = "12"

=xs:decimal value = "4"

MoneyType
Java class for the InboundShipmentStatusType simple type.

MoneyType element
Name Type Description
MoneyType decimal Use the CurrencyType instead, for international support.
(DEPRECATED)

OrderFulfillmentType
Defines the kind of fulfillment for this order.

OrderFulfillmentType values
Name Type Description
ALLOW_PARTIAL_FILL string Allow partial order fulfillment

Name Type Description

DISALLOW_PARTIAL_FILL string Disallow partial order fulfillment

ReasonCode
Status codes for return reasons.

ReceiptStatusType values
Name Type Description
BUYERS_REMORSE string Customer regrets the purchase.
ITEM_DEFECTIVE string Item has some defect.
DAMAGED_IN_TRANSIT string Item damaged during transport by the carrier.

MISSING_PARTS string Item is incomplete; missing parts.

WRONG_ITEM_RECEIVED string Wrong item received.
NON_BUYERS_REMORSE string Item returned for an unspecific reason.
ReceiptStatus
Java class for the receiptStatus simple type.

ReceiptStatusType values
Name Type Description
ERROR string Shipment triggered an error upon receipt.
RECEIVED_SELLABLE string Shipment received; product sellable.
RECEIVED_DAMAGED string Shipment received; product damaged.

REFUSED_DAMAGED string Shipment refused; product damaged.

Name Type Description
REFUSED_OVERAGE string Shipment refused; inventory overage.
RECEIVED_ON_HOLD string Shipment received and held, pending transaction.

SalesOrderLineCancelReasonType
Java class for the SalesOrderLineCancelReasonType simple type.

SalesOrderLineCancelReasonType values
Name Type Description
INSUFFICIENT_QUANTITY string Numeric count too low for fulfillment
UNKNOWN_ITEM string OrderLine item cannot identified
USER_CANCELED string Supplier canceled order line
USER_CANCELLED string Supplier cancelled order line

CUSTOMER_CANCELLED string Customer cancelled order line

UNRECOGNIZED_BY_WAREHOUSE string SalesOrderLine item not recognized
NOT_AVAILABLE_AT_WAREHOUSE string SalesOrderLine item not available

SalesOrderLineStatusType
Java class for the SalesOrderLineStatusType simple type.

SalesOrderLineStatusType values
Name Type Description
PROCESSING string SalesOrderLine is being fulfilled.
SHIPPED string OrderLine item has shipped.
CANCELED string SalesOrderLine was canceled.

CANCELLED string SalesOrderLine was cancelled

ENTERED string SalesOrderLine is in SOFS.
RESERVED string SalesOrderLine item is reserved, pending further action.
ACCEPTED pending SalesOrderLine is part of a valid order.

SalesOrderStatusType
Java class for the SalesOrderStatusType simple type.

SalesOrderStatusType values
Name Type Description
PROCESSING string SalesOrder is being processed.
COMPLETE string SalesOrder is complete; no missing data.
CANCELED string SalesOrder is canceled.
CANCELLED string SalesOrder is cancelled.
ENTERED string SalesOrder is in SOFS
ACCEPTED string SalesOrder is valid, accepted for fulfillment.

ACKNOWLEDGED string SalesOrder is acknowledged by the partner.

ShipmentStatusType
Java class for the ShipmentStatusType simple type.

ShipmentStatusType values
Name Type Description
PENDING string SOFS is processing this inbound shipment
OPEN string Warehouse received this inbound shipment notification but has not received the
product on site.
CLOSED string All lines for this inbound shipment have been received by the warehouse.

ERROR string Inbound shipment had an error while being processed.

Name Type Description

CANCELLED string This line of the PO has been cancelled.
ACCEPTED string Shipment is accepted by warehouse.
RECEIVING string Shipment is at warehouse, pending acceptance.
REJECTED string Shipment rejected by warehouse.
DRAFT string Shipment information is in draft state.

XSD’s
BatchJob XSD:

<?xml version="1.0" encoding="utf-8" ?>

<!--Created with Liquid XML Studio Developer Edition (Trial) 9.0.11.3078 (http://www.liquid-technologies.com) -->
<xs:schema xmlns="api.supplieroasis.com" elementFormDefault="qualified"
targetNamespace="api.supplieroasis.com" version="1.0"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
jaxb:version="2.1"
xmlns:annox="http://annox.dev.java.net"
jaxb:extensionBindingPrefixes="annox">

<xs:element name="batchJobProgress" type="BatchJobProgressType" />

<xs:complexType name="BatchJobProgressType">
<xs:sequence>
<xs:element minOccurs="1" name="batchJobId" type="xs:long" />
<xs:element minOccurs="0" name="batchJobName" type="xs:string">
<xs:annotation>
<xs:documentation>Optional user-defined convenience identifier. Does not need to be unique</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="1" name="status" type="xs:string" />
<xs:element minOccurs="1" name="totalRecordCount" type="xs:int" />
<xs:element minOccurs="1" name="recordsProcessedSoFar" type="xs:int">
<xs:annotation>
<xs:documentation>Approximate number of records that have been processed thus far</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>
Common Types XSD:

<?xml version="1.0" encoding="utf-8" ?>

<!--Created with Liquid XML Studio Developer Edition (Trial) 9.0.11.3078 (http://www.liquid-technologies.com)-->
<xs:schema xmlns="api.supplieroasis.com" elementFormDefault="qualified"
targetNamespace="api.supplieroasis.com" version="1.0"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
jaxb:version="2.1"
xmlns:annox="http://annox.dev.java.net"
jaxb:extensionBindingPrefixes="annox">
<xs:complexType name="AddressType">
<xs:annotation>
<xs:documentation>Type used to describe and address.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="contactName" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the person associated with the address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="address1" type="xs:string">
<xs:annotation>
<xs:documentation>The first line of the address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="address2" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>An optional additional line for the address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="address3" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Another optional additional line for the address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="district" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The name of the district for the address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="city" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the city for the address.</xs:documentation>
</xs:annotation>
 </xs:element>
<xs:element name="stateOrProvince" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>The code for the state for province, for example CA or NY.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="postalCode" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>The postal code for the address, which is zip code in the U.S., for
example.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="countryCode" type="xs:string">
<xs:annotation>
<xs:documentation>The code for the country, for example US.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="phone" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>Phone number associated with the address, if any.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="alternatePhone" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>An addition alternate phone number, if any.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="email" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Email address associated with the address.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ProductUnitOfMeasureType">
<xs:annotation>
<xs:documentation>
A code to indicate the unit of measure for a product. Examples may include EA (Each), BX (Box).
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="CodeType"/>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="LengthUnitOfMeasureType">
<xs:annotation>
<xs:documentation>Code for the unit of measure for a linear measurement</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="CodeType"/>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="WeightUnitOfMeasureType">
<xs:annotation>
<xs:documentation>Code for the unit of measure for weight</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="CodeType"/>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="MoneyType">
<xs:annotation>
<xs:documentation>
This element is deprecated. Please use CurrencyType for international support.
A type to denote currency. As of now, all money types are are in US Dollars.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="CurrencyType">
<xs:sequence>
<xs:element name="amount" type="CurrencyAmountType">
<xs:annotation>
<xs:documentation>Amount of money in currency code denominations.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="currencyCode" type="CurrencyCodeType" default="USD">
<xs:annotation>
<xs:documentation>Type of currency denomination</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="CurrencyCodeType" xml:base="CodeSimpleType">
<xs:annotation>
<xs:documentation>
Currencies are identified by their ISO 4217 currency codes.
 Visit the http://www.iso.org/iso/en/prods-services/popstds/currencycodes.html ISO web site for more
information, including a table of currency codes.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<!-- these are the supported currency code values -->
<xs:enumeration value="USD" />
<xs:enumeration value="CNY" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="CurrencyAmountType">
<xs:annotation>
<xs:documentation>A type to denote currency amount</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="CodeType">
<xs:annotation>
<xs:documentation>
A CodeType contains an xs:string which resolves to a code. Codes are used as abbreviations of longer names.
For example, a state code of CA represents California. The intent of the code is to allow systems to process
based on a known set of values. Typically, these values are fairly static but may occasionally change.
For Supplier Oasis, the code list for a particular type will be made available on the Supplier Oasis API Website.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="code" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="CodeSimpleType" xml:base="xs:string">
<xs:annotation>
<xs:documentation>
A CodeType is an xs:string which contains a coded value. The intent of the code is to allow systems to proc ess
based on a known set of values. Typically, these values are fairly static but may occasionally change.
For Supplier Oasis, the code list for a particular type will be made available on the Supplier Oasis API Website.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="(A-Z)*"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="warehouseName" type="CodeType">
 <xs:annotation>
<xs:documentation>A unique identifier for a warehouse.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="retailChannelCode" type="xs:string">
<xs:annotation>
<xs:documentation>A unique identifier for the retail channel.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="retailerOrderCode" type="xs:string">
<xs:annotation>
<xs:documentation>Retail order numbers are not guaranteed to be unique for a retailer. This is an additional field
that can be passed from the retailer to distinguish an order, if the order number is non-unique</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="retailOrderNumber" type="xs:string">
<xs:annotation>
<xs:documentation>The retailer-specific order number that the customer gets on checkout</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>

InventoryUpdate XSD:

<?xml version="1.0" encoding="utf-8" ?>

<!--Created with Liquid XML Studio Developer Edition (Trial) 9.0.11.3078 (http://www.liquid-technologies.com)-->
<xs:schema xmlns="api.supplieroasis.com" elementFormDefault="qualified"
targetNamespace="api.supplieroasis.com" version="1.0"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
jaxb:version="2.1"
xmlns:annox="http://annox.dev.java.net"
jaxb:extensionBindingPrefixes="annox">
<xs:include schemaLocation="CommonTypes.xsd"/>
<xs:element name="currentInventoryMessage" type="CurrentInventoryMessageType"/>
<xs:element name="inventoryHistory" type="InventoryHistoryMessageType"/>
<xs:element name="skuInventoryHistory" type="SkuInventoryHistoryMessageType"/>
<xs:complexType name="CurrentInventoryMessageType">
<xs:annotation>
<xs:documentation>
Defines the current inventory for a set of products (SKUs) at each warehouse
</xs:documentation>
 </xs:annotation>
<xs:sequence maxOccurs="unbounded">
<xs:element name="currentInventory" type="CurrentInventoryType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="InventoryHistoryMessageType">
<xs:annotation>
<xs:documentation>Defines a history of inventory changes to a product. Inventory changes may be positive or
negative.</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="unbounded">
<xs:element name="inventoryAdjustment" type="InventoryAdjustmentType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SkuInventoryHistoryMessageType">
<xs:annotation>
<xs:documentation>A message to contain inventory adjustments one or many adjustments to a spific SK U across
multiple warehouses.</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="unbounded">
<xs:element name="SkuInventoryAdjustment" type="SkuInventoryAdjustmentType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ProductDescriptionType">
<xs:annotation>
<xs:documentation>The description of the product that has inventory.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="partnerSku" type="xs:string">
<xs:annotation>
<xs:documentation>The partner defined SKU for the product.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="productUnitOfMeasure" type="ProductUnitOfMeasureType">
<xs:annotation>
<xs:documentation>The unit of measure for this product.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="WarehouseInventoryAdjustmentType">
<xs:annotation>
<xs:documentation>A quantity adjustment at a specific warehouse.</xs:documentation>
</xs:annotation>
 <xs:sequence>
<xs:element ref="warehouseName"/>
<xs:element minOccurs="0" name="barcode" type="xs:string">
<xs:annotation>
<xs:documentation>Only required if the barcode for this item is different from the SKU</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="quantity" type="xs:long" minOccurs="1"> <!-- why is this a long and not int??? -->
<xs:annotation>
<xs:documentation>The adjustment to quantity, positive or negative.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reasonCode" type="CodeType">
<xs:annotation>
<xs:documentation>The reason for this adjustment. Reason codes and descriptions are provided by the Supplier
Oasis API. </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="adjustmentDate" type="xs:dateTime">
<xs:annotation>
<xs:documentation>The date the inventory adjustment was processed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="backorderTimestamp" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Timestamp for the back order quantity.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SkuInventoryAdjustmentType">
<xs:annotation>
<xs:documentation>Adjustments to quantities for a specific product at multiple warehouses.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="productDescription" type="ProductDescriptionType"/>
<xs:element maxOccurs="unbounded" name="warehouseInventoryAdjustment"
type="WarehouseInventoryAdjustmentType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="InventoryAdjustmentType">
<xs:annotation>
<xs:documentation>An adjustment to the quantity of a specific product at a specific
warehouse.</xs:documentation>
</xs:annotation>
 <xs:sequence>
<xs:element name="productDescription" type="ProductDescriptionType"/>
<xs:element name="warehouseInventoryAdjustment" type="WarehouseInventoryAdjustmentType"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="AbsoluteQuantityType">
<xs:annotation>
<xs:documentation>A definition of a quantity that cannot be less than zero.</ xs:documentation>
</xs:annotation>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="CurrentWarehouseQuantityType">
<xs:annotation>
<xs:documentation>The quantites of a product at a specific warehouse.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="warehouseName"/>
<xs:element minOccurs="0" name="barcode" type="xs:string">
<xs:annotation>
<xs:documentation>An optional field to indicate a barcode for this item that may be different than the
SKU.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="currentInventoryQuantityDetails"
type="CurrentInventoryQuantityDetailsType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CurrentInventoryQuantityDetailsType">
<xs:annotation>
<xs:documentation>The breakdown of specific types of inventory for an item. </xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="totalQuantity" type="AbsoluteQuantityType">
<xs:annotation>
<xs:documentation>The total quantity that physically resides at the warehouse. This will be the sum of all the
provided specific quantities. </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reserved" type="AbsoluteQuantityType">
<xs:annotation>
<xs:documentation>The quantity that has been reserved for sales orders. A product will have this state once
a sales order is received but has not yet shipped.</xs:documentation>
</xs:annotation>
 </xs:element>
<xs:element name="sellable" type="AbsoluteQuantityType">
<xs:annotation>
<xs:documentation>The quantity that is available for sale.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="onHold" type="AbsoluteQuantityType">
<xs:annotation>
<xs:documentation>The quantity that has been temporarily flagged buy the warehouse as not sellable or
reserved. This state may be used to identify damaged good.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="backorderQuantity" type="AbsoluteQuantityType" minOccurs="0">
<xs:annotation>
<xs:documentation>Total quantity available on backorder.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="backorderQuantityReserved" type="AbsoluteQuantityType" minOccurs="0">
<xs:annotation>
<xs:documentation>The quantity that has been reserved in backorders</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CurrentInventoryType">
<xs:annotation>
<xs:documentation>Shows the current inventory for a speific product at multiple
warehhouses.</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="1">
<xs:element name="productDescription" type="ProductDescriptionType"/>
<xs:element name="currentWarehouseQuantity" type="CurrentWarehouseQuantityType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:element name="supplierInventoryMessage" type="SupplierInventoryMessageType"/>
<xs:complexType name="SupplierInventoryMessageType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="supplierInventory" type="SupplierInventoryType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierInventoryType">
<xs:sequence>
<xs:element name="partnerSku" type="xs:string">
<xs:annotation>
 <xs:documentation>The SKU for the inventory update.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" name="supplierWarehouseQuantity"
type="SupplierWarehouseQuantityType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierWarehouseQuantityType">
<xs:sequence>
<xs:element ref="warehouseName"/>
<xs:element name="quantity" type="AbsoluteQuantityType" minOccurs="1">
<xs:annotation>
<xs:documentation>The new quantity.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="timestamp" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Timestamp for the quantity.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="barcode" type="xs:string">
<xs:annotation>
<xs:documentation>Only required if the barcode for this item is different from the SKU</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="backorderTimestamp" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Timestamp for the back order quantity. If present, indicates this
SupplierWarehouseQuantityType should be considered a back order.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="supplierInventoryResponseMessage" type="SupplierInventoryResponseMessageType"/>
<xs:complexType name="SupplierInventoryResponseMessageType">
<xs:annotation>
<xs:documentation>Defines a collection inventory create/update responses.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="successCount" type="xs:int"/>
<xs:element name="errorCount" type="xs:int"/>
<xs:element name="supplierInventoryResponse" type="SupplierInventoryResponseType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
 <xs:complexType name="SupplierInventoryResponseType">
<xs:annotation>
<xs:documentation>Defines an inventory create/update response for one partnerSku.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="partnerSku" type="xs:string"/>
<xs:element name="supplierWarehouseQuantityResponse" type="SupplierWarehouseQuantityResponseType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierWarehouseQuantityResponseType">
<xs:annotation>
<xs:documentation>Defines an inventory create/update response.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="success" type="xs:boolean"/>
<xs:element name="message" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Error or other message</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="supplierWarehouseQuantity" type="SupplierWarehouseQuantityType">
<xs:annotation>
<xs:documentation>The original single inventory create/update request.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>

SalesOrder XSD:

<?xml version="1.0" encoding="utf-8" ?>

<!--Schema for processing Sales Orders-->
<xs:schema xmlns="api.supplieroasis.com" elementFormDefault="qualified"
targetNamespace="api.supplieroasis.com" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" jaxb:version="2.1"
xmlns:annox="http://annox.dev.java.net" jaxb:extensionBindingPrefixes="annox">
<xs:include schemaLocation="CommonTypes.xsd"/>
<xs:element name="processedSalesOrderTypeList" type="ProcessedSalesOrderTypeListType">
<xs:annotation>
<xs:documentation>Wrapper for processedSalesOrderMessage. Contains a total count of elements for conveninece.
 </xs:documentation>
</xs:annotation>
<xs:element name="totalCount" type="xs:long" />
<xs:element name="processedSalesOrderMessage" type="ProcessedSalesOrderMessageType">
<xs:annotation>
<xs:documentation>Contains information about a sales order that exists in the Supplier Oasis network.
Information flows from Supplier Oasis to partner.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesOrderMessage" type="SalesOrderMessageType">
<xs:annotation>
<xs:documentation>Contains information about a sales order being submitted to the Supplier Oasis network.
Information flows from partner to Supplier Oasis.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesOrderResponseMessage" type="SalesOrderResponseMessageTy pe">
<xs:annotation>
<xs:documentation>Response message that can provide details if errors are encountered while processing a
salesOrderMessage.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="supplierShipmentMessage" type="SupplierShipmentMessageType"/>
<xs:element name="supplierShipmentResponseMessage" type="SupplierShipmentResponseMessageType"/>
<xs:element name="salesOrderResponseType" type="SalesOrderResponseType"/>
<xs:complexType name="SalesOrderResponseType">
<xs:sequence>
<xs:element ref="salesChannelName"/>
<xs:element ref="salesChannelOrderNumber"/>
<xs:element maxOccurs="unbounded" name="salesOrderResponseCode" type="CodeType"/>
<xs:element maxOccurs="unbounded" name="salesOrderLineResponse"
type="SalesOrderLineResponseType"/>
</xs:sequence>
</xs:complexType>
<xs:element name="salesChannelName" type="xs:string">
<xs:annotation>
<xs:documentation>Mnemonic identifier for the sales channel.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelOrderNumber" type="xs:string">
<xs:annotation>
<xs:documentation>External sales order number, as entered in the sales channel's system.</xs:documentation>
 </xs:annotation>
</xs:element>
<xs:complexType name="SalesOrderResponseMessageType">
<xs:annotation>
<xs:documentation>Type to indicate errors encountered while processing the
salesOrderMessage.</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="1">
<xs:element name="successCount" type="xs:int"/>
<xs:element name="errorCount" type="xs:int"/>
<xs:element maxOccurs="unbounded" name="salesOrderResponse" type="SalesOrderResponseType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ProcessedSalesOrderMessageType">
<xs:annotation>
<xs:documentation>Message containing one or more processed sales orders.
Information flows from Supplier Oasis to partner.
</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="unbounded">
<xs:element name="processedSalesOrder" type="ProcessedSalesOrderType">
<xs:annotation>
<xs:documentation>Information about a sales order which exists in the Supplier Oasis network.
Includes basic identifying information and one or more sales order lines.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SalesOrderMessageType">
<xs:annotation>
<xs:documentation>Message containing one or more sales orders being submitted.
Information flows from partner to Supplier Oasis.
</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="unbounded">
<xs:element name="salesOrder" type="SalesOrderType">
<xs:annotation>
<xs:documentation>Information about a sales order being submitted to the Supplier Oasis network.
Includes basic identifying information and one or more sales order lines.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ProcessedSalesOrderType">
<xs:complexContent>
<xs:extension base="SalesOrderBaseType">
<xs:sequence>
<xs:element name="orderId" type="xs:long">
<xs:annotation>
<xs:documentation>Supplier Oasis's unique identifier for the sales order.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="SalesOrderStatusType">
<xs:annotation>
<xs:documentation>Status of order as a whole within the Supplier Oasis network.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="retailChannelCode"/>
<xs:element minOccurs="0" ref="retailerOrderCode"/>
<xs:element minOccurs="0" ref="retailOrderNumber"/>
<xs:element name="backorderDate" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Date back order product arrives at warehouse</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="actionRequired" type="xs:boolean">
<xs:annotation>
<xs:documentation>Whether further action is required to complete processing of the order.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="processedSalesOrderLine" type="ProcessedSalesOrderLineType"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ProcessedSalesOrderLineType">
<xs:complexContent>
<xs:extension base="SalesOrderLineType">
<xs:sequence>
<xs:element name="lineId" type="xs:long">
<xs:annotation>
<xs:documentation>Supplier Oasis primary key for sales order line.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="itemId" type="xs:long">
<xs:annotation>
 <xs:documentation>Supplier Oasis identifier for the item ordered on this line.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="itemName" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the item</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lineStatus" type="SalesOrderLineStatusType">
<xs:annotation>
<xs:documentation>Status of this line only.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="cancelReason" type="SalesOrderLineCancelReasonType" minOccurs="0">
<xs:annotation>
<xs:documentation>The reason that a line was cancelled (short shipped).
Null for lines that are not in CANCELLED status.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="unitCost" type="MoneyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Unit cost for the item on this order line.
Reserved for future use. No current functionality.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="unitCostCurrencyCode" type="CurrencyCodeType" default="USD"
minOccurs="0">
<xs:annotation>
<xs:documentation>Currency code for unitCost</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shipConfirmationDetail" type="ShipConfirmationType" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Relates to one package for one order line.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="notes" type="xs:string">
<xs:annotation>
<xs:documentation/>
</xs:annotation>
</xs:element>
<xs:element name="firstCost" type="MoneyType" minOccurs="0">
 <xs:annotation>
<xs:documentation>Price retailer pays to the supplier.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="firstCostCurrencyCode" type="CurrencyCodeType" default="USD"
minOccurs="0">
<xs:annotation>
<xs:documentation>Currency code for firstCost</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="additionalShippingCost" type="MoneyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Additional cost for expedited shipping.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="additionalShippingCostCurrencyCode" type="CurrencyCodeType"
default="USD" minOccurs="0">
<xs:annotation>
<xs:documentation>Currency code for additionalShippingCost</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ShippingSpecificationsType">
<xs:sequence>
<xs:element name="isThirdPartyBilling" type="xs:boolean" minOccurs="1">
<xs:annotation>
<xs:documentation>If billing third party billing on your sales channel.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="isSignatureRequired" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Indication if a signature is required for this sales order.
If blank, FALSE is assumed.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="isDeclaredValueRequired" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Indication if a declared value is required for this sales order.
If TRUE, Warehouse will calculate from Replacement Cost. If blank, FALSE is assumed.
</xs:documentation>
 </xs:annotation>
</xs:element>
<xs:element name="transportationTerms" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Trade terms that apply to the shipment. Applies to export.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="smallParcelShipment" type="SmallParcelShipmentType"/>
<xs:element name="ltlShipment" type="LTLShipmentType"/>
<xs:element name="lightWeight0to16OzShipment" type="LightWeight0to16OzShipmentType"/>
<xs:element name="lightWeightGreaterThan1LbShipment"
type="LightWeightGreaterThan1LbShipmentType"/>
</xs:choice>
<xs:element name="isExport" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether or not the order is for export.
Required as TRUE for APO/FPO. If blank, FALSE is assumed.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ThirdPartyBillingShipmentType">
<xs:sequence/>
</xs:complexType>
<xs:complexType name="NonThirdPartyBillingShipmentType">
<xs:sequence>
<xs:element ref="shippingServiceLevel"/>
<xs:element minOccurs="1" ref="carrier">
<xs:annotation>
<xs:documentation>Designation of carrier to ship this order.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="billingAccountNumber" minOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SalesOrderLineResponseType">
<xs:sequence>
<xs:element ref="salesChannelLineId" minOccurs="0">
<xs:annotation>
<xs:documentation>DEPRECATED in favor of the salesChannelLineNumber. External sales order line number, as
entered in the sales channel's system.
</xs:documentation>
 </xs:annotation>
</xs:element>
<xs:element ref="salesChannelLineNumber" minOccurs="1"/>
<xs:element maxOccurs="unbounded" name="salesOrderLineResponseCode" type="CodeType"/>
</xs:sequence>
</xs:complexType>
<xs:element name="carrier" type="CodeType">
<xs:annotation>
<xs:documentation>The carrier to ship the order with.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shippingServiceLevel" type="CodeType">
<xs:annotation>
<xs:documentation>Service level for shipment of the order.
If not specified, Ground or Basic service is assumed.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelLineId" type="xs:long">
<xs:annotation>
<xs:documentation>DEPRECATED in favor of the salesChannelLineNumber. External sales order line number, as
entered
in the sales channel's system.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelLineNumber" type="xs:long">
<xs:annotation>
<xs:documentation>External sales order line number, as entered in the sales channel's system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="BrandingType">
<xs:sequence>
<xs:element name="packingSlipPromoText" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Promotional text for the sales channel to appear on the packing slip.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="returnPolicyText" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Return policy to print on the packing slip.
Should be present if off-network order or white-label order.
</xs:documentation>
</xs:annotation>
 </xs:element>
<xs:element name="brand" type="CodeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Indication of the branding of the order.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PackageDetailType">
<xs:sequence>
<xs:element name="packageID" type="xs:long">
<xs:annotation>
<xs:documentation>Supplier Oasis identifier for shipment package.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="packageType" type="CodeType">
<xs:annotation>
<xs:documentation>Type of package.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="packageNumber" type="xs:long">
<xs:annotation>
<xs:documentation>Package n of total in shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="packageWeight" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>Weight of package as displayed on label.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="packageWeightUnitOfMeasure" type="CodeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Unit of measure for the package weight.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="trackingNumber" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Carrier tracking number for this package.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ShipmentDetailType">
<xs:sequence>
<xs:element name="shipmentID" type="xs:long">
 <xs:annotation>
<xs:documentation>Supplier Oasis primary key for shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shipmentCarrier" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Carrier for this shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="billingAccountNumber" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>freight account number used for billing the shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="billOfLadingNumber" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Bill of Lading # for LTL shipments.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element minOccurs="0" ref="shippingServiceLevel"/>
<xs:element name="carrierReferenceNumber" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Carrier Reference for LTL shipments.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dateShipped" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Date of shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dateConfirmed" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Date that shipment was confirmed as shipped.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" ref="warehouseName"/>
<xs:element minOccurs="0" name="supplierInvoiceNumber" type="xs:string">
<xs:annotation>
<xs:documentation>Suppliers Invoice Number to link to Retailers Order Line
</xs:documentation>
</xs:annotation>
</xs:element>
 </xs:sequence>
</xs:complexType>
<xs:complexType name="ShipConfirmationType">
<xs:sequence>
<xs:element name="quantityShipped" type="xs:long">
<xs:annotation>
<xs:documentation>Sales order line quantity shipped in this package.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="packageDetail" type="PackageDetailType"/>
<xs:element name="shipmentDetail" type="ShipmentDetailType"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="SalesOrderStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="PROCESSING"/>
<xs:enumeration value="COMPLETE"/>
<xs:enumeration value="CANCLED"/>
<xs:enumeration value="CANCELLED"/>
<xs:enumeration value="ENTERED"/>
<xs:enumeration value="ACCEPTED"/>
<xs:enumeration value="ACKNOWLEDGED"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="SalesOrderLineStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="PROCESSING"/>
<xs:enumeration value="SHIPPED"/>
<xs:enumeration value="CANCELED"/>
<xs:enumeration value="CANCELLED"/>
<xs:enumeration value="ENTERED"/>
<xs:enumeration value="RESERVED"/>
<xs:enumeration value="ACCEPTED"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="SalesOrderLineCancelReasonType">
<xs:restriction base="xs:string">
<xs:enumeration value="INSUFFICIENT_QUANTITY"/>
<xs:enumeration value="UNKNOWN_ITEM"/>
<xs:enumeration value="USER_CANCLED"/>
<xs:enumeration value="USER_CANCELLED"/>
<xs:enumeration value="CUSTOMER_CANCELLED"/>
<xs:enumeration value="UNRECOGNIZED_BY_WAREHOUSE"/>
<xs:enumeration value="NOT_AVAILABLE_AT_WAREHOUSE"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="OrderFulfillmentType">
<xs:restriction base="xs:string">
<xs:enumeration value="ALLOW_PARTIAL_FILL"/>
<xs:enumeration value="DISALLOW_PARTIAL_FILL"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="SalesOrderBaseType">
<xs:sequence>
<xs:element name="salesChannelOrderNumber" type="xs:string">
<xs:annotation>
<xs:documentation>External sales order number, as entered in the sales channel's system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelName" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Mnemonic identifier for the retailer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="orderDate" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Date that the order was placed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="sofsCreatedDate" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Date that the order was created in sofs system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="warehouseName" minOccurs="1">
<xs:annotation>
<xs:documentation>Mnemonic identifier for the warehouse fulfilling the sales order.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customerId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Identifier for the customer. For example, username.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customerAddress" type="AddressType" minOccurs="0">
<xs:annotation>
<xs:documentation>Recipient address for this order. Phone number is required for export.</xs:documentation>
</xs:annotation>
</xs:element>
 <xs:element name="shipToAddress" type="AddressType">
<xs:annotation>
<xs:documentation>Recipient address for this order. Phone number is required for export.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="returnAddress" type="AddressType">
<xs:annotation>
<xs:documentation>Return address for this order. Prints on packing slip/shipping label. Required for
off-network orders.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shippingSpecifications" type="ShippingSpecificationsType"/>
<xs:element name="branding" type="BrandingType"/>
<xs:element name="orderFulfillment" type="OrderFulfillmentType" minOccurs="1">
<xs:annotation>
<xs:documentation>How to fulfill the order, e.g. whether partial fulfillment is allowed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="totalValue" type="CurrencyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Total value of the order</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="totalValuePaid" type="CurrencyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Total value of the order less any credits. This is the actual amount the customer is
charged.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shippingTotal" type="CurrencyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Total shipping amount of the order</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SalesOrderType">
<xs:annotation>
<xs:documentation>Defines the basic data for a sales order, which is base identifying information plus 1 or more
sales order lines.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="SalesOrderBaseType">
 <xs:sequence>
<xs:element name="salesOrderLine" type="SalesOrderLineType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="SalesOrderLineType">
<xs:annotation>
<xs:documentation>Defines the basic data for a single line on a sales order.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="salesChannelLineId" minOccurs="0">
<xs:annotation>
<xs:documentation>DEPRECATED in favor of the salesChannelLineNumber. External sales order line number, as
entered in the sales channel's system.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="1" ref="salesChannelLineNumber">
<xs:annotation>
<xs:documentation>External sales order line number, as entered in the sales channel's system.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="partnerSKU" type="xs:string">
<xs:annotation>
<xs:documentation>Partner's unique identifier for the merchandise represented by this order line.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="barcode" type="xs:string">
<xs:annotation>
<xs:documentation>An optional field to indicate a barcode for this item that may be different than the SKU.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="upc" type="xs:string">
<xs:annotation>
<xs:documentation>An optional field to indicate a Universal product code for product.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelSKU" type="xs:string">
<xs:annotation>
 <xs:documentation>The SKU for this merchandise as known by the sales channel.
Prints on the packing slip.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="quantity" type="xs:long">
<xs:annotation>
<xs:documentation>Number of units ordered on this order line.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="specialHandling" type="CodeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Code defining outbound special handling for this order line. Legacy field
replaced by specialHandlingCode
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="giftWrapText" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The text to put on gift wrapping card.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="itemPrice" type="MoneyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Unit price for the item on this order line.
Required for export only.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="itemPriceCurrencyCode" type="CurrencyCodeType" default="USD" minOccurs="1">
<xs:annotation>
<xs:documentation>Currency code for itemPrice</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="vatRate" type="xs:decimal" minOccurs="0">
<xs:annotation>
<xs:documentation>VAT rate for this item.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="promotionType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Indicates this is a Holiday or Time in Transit promotion</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="deliveryByDate" type="xs:dateTime" minOccurs="0">
 <xs:annotation>
<xs:documentation>Date product promised to customer</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="isReplacementOrder" type="xs:boolean" minOccurs="0" default="false">
<xs:annotation>
<xs:documentation> Indicates if this Order is a Replacement order or not</xs:documentation>
</xs:annotation>
</xs:element>
<xs:sequence>
<xs:element name="specialHandlingCode" type="SpecialHandlingCodeType" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Codes defining outbound special handling for this order line.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>

</xs:sequence>

</xs:complexType>
<xs:complexType name="SpecialHandlingCodeType">
<xs:annotation>
<xs:documentation>Defines the basic data for special handling code.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="specialHandlingCode" type="CodeType">
<xs:annotation>
<xs:documentation>a special handling code for this SalesOrder Line</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LTLShipmentType">
<xs:annotation>
<xs:documentation>Shipment details which apply to LTL shipping solutions.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="freightPayorAddress" type="AddressType" minOccurs="0"/>
<xs:element minOccurs="0" name="ltlServiceLevel" type="CodeType">
<xs:annotation>
<xs:documentation>Level of Service for this LTL shipment. (Curbside, White Glove, etc.)</xs:documentation>
</xs:annotation>
</xs:element>
 <xs:element name="carrierNotes" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Optional notes for the carrier.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="carrier" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LightWeight0to16OzShipmentType">
<xs:annotation>
<xs:documentation>Shipment details which apply to lightweight shipping solutions for packages less than 1 LB.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="shippingServiceLevel"/>
<xs:element minOccurs="0" ref="shipperOfRecordAccountNumber"/>
<xs:element minOccurs="0" ref="carrier"/>
<xs:element minOccurs="0" ref="uspsMailerId"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LightWeightGreaterThan1LbShipmentType">
<xs:annotation>
<xs:documentation>Shipment details which apply to lightweight shipping solutions for packages from 1 to 8 LBS.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="shippingServiceLevel"/>
<xs:element minOccurs="0" ref="shipperOfRecordAccountNumber"/>
<xs:element minOccurs="0" ref="carrier"/>
<xs:element minOccurs="0" ref="uspsMailerId"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SmallParcelShipmentType">
<xs:annotation>
<xs:documentation>Shipment details which apply to parcel shipping solutions, such as UPS and FedEx.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="shippingServiceLevel"/>
<xs:element minOccurs="0" ref="billingAccountNumber"/>
<xs:element minOccurs="0" ref="shipperOfRecordAccountNumber"/>
<xs:element minOccurs="0" ref="carrier"/>
<xs:element minOccurs="0" ref="uspsMailerId"/>
</xs:sequence>
</xs:complexType>
<xs:element name="billingAccountNumber" type="xs:string">
<xs:annotation>
<xs:documentation>Account number used for billing this shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shipperOfRecordAccountNumber" type="xs:string">
<xs:annotation>
<xs:documentation>Partner's identifying account number with the carrier.
Not necessarily the same as the Shipping Account Number used for billing.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="uspsMailerId" type="xs:string">
<xs:annotation>
<xs:documentation>Mailer ID defined by USPS.
Required for UPSMI, Fedex Smartpost, UPS Surepost, DHL Global Mail and USPS.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="SupplierShipmentMessageType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="supplierShipment" type="SupplierShipmentType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierShipmentType">
<xs:sequence minOccurs="1">
<xs:element name="supplierSku" minOccurs="0" type="xs:string">
<xs:annotation>
<xs:documentation>The supplier SKU shipped.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelName" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>Mnemonic identifier for the retailer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="salesChannelOrderNumber" minOccurs="1"/>
<xs:element ref="retailOrderNumber" minOccurs="0"/>
<xs:element ref="salesChannelLineNumber" minOccurs="1"/>
<xs:element name="warehouse" type="CodeType" minOccurs="1">
<xs:annotation>
<xs:documentation>A unique identifier for the warehouse.</xs:documentation>
</xs:annotation>
</xs:element>
 <xs:sequence minOccurs="1">
<xs:element name="supplierShipConfirmation" type="SupplierShipConfirmationType"
minOccurs="1"/>
<xs:element name="shortShip" type="ShortShipType" minOccurs="1"/>
</xs:sequence>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierShipConfirmationType">
<xs:sequence>
<xs:element name="quantity" type="xs:integer" minOccurs="1">
<xs:annotation>
<xs:documentation>Quantity shipped.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="carrier" minOccurs="1"/>
<xs:element name="trackingNumber" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>The carrier tracking number for the shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shipDate" type="xs:dateTime" minOccurs="1">
<xs:annotation>
<xs:documentation>Date shipped.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="serviceLevel" type="CodeType">
<xs:annotation>
<xs:documentation>Service level of the shipment.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="supplierInvoiceNumber" type="xs:string">
<xs:annotation>
<xs:documentation>Suppliers Invoice Number to link to Retailers Order Line
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="sequenceNumber" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Sequence Number to allow same tracking numner for multiple
shipments.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ShortShipType">
 <xs:sequence>
<xs:element minOccurs="0" name="reasonCode" type="CodeType">
<xs:annotation>
<xs:documentation>Reason code for short ship.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierShipmentResponseMessageType">
<xs:sequence>
<xs:element name="successCount" type="xs:int"/>
<xs:element name="errorCount" type="xs:int"/>
<xs:element maxOccurs="unbounded" name="supplierShipmentResponse"
type="SupplierShipmentResponseType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SupplierShipmentResponseType">
<xs:sequence>
<xs:element name="success" type="xs:boolean"/>
<xs:element minOccurs="0" name="errorCode" type="CodeType"/>
<xs:element name="supplierShipment" type="SupplierShipmentType"/>
</xs:sequence>
</xs:complexType>
<xs:element name="salesOrderAcknowledgementMessage" type="SalesOrderAcknowledgementMessageType">
<xs:annotation>
<xs:documentation>Contains information about a sales order being acknowledged by the
Supplier.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="SalesOrderAcknowledgementMessageType">
<xs:annotation>
<xs:documentation>Message containing one or more sales orders being Acknowledged.
Information flows from Supplier to Supplier Oasis.
</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="unbounded">
<xs:element name="salesOrderAcknowledgement" type="SalesOrderAcknowledgementType">
<xs:annotation>
<xs:documentation>Information about a sales order being acknowledged to the Supplier Oasis network.
Includes basic identifying information and one or more sales orders.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
 </xs:complexType>
<xs:complexType name="SalesOrderAcknowledgementType">
<xs:sequence>
<xs:element name="salesChannelOrderNumber" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>External sales order number, as entered in the sales channel's system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="salesChannelName" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation>Mnemonic identifier for the retailer.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SalesOrderAcknowledgementResponseMessageType">
<xs:annotation>
<xs:documentation>Type to indicate errors encountered while processing the
salesOrderAcknowledgementMessage.</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="1">
<xs:element name="successCount" type="xs:int"/>
<xs:element name="errorCount" type="xs:int"/>
<xs:element maxOccurs="unbounded" name="salesOrderAcknowledgementResponse"
type="SalesOrderAcknowledgementResponseType"/>
</xs:sequence>
</xs:complexType>
<xs:element name="salesOrderAcknowledgementResponseMessage"
type="SalesOrderAcknowledgementResponseMessageType"/>
<xs:complexType name="SalesOrderAcknowledgementResponseType">
<xs:sequence>
<xs:element ref="salesChannelName"/>
<xs:element ref="salesChannelOrderNumber"/>
<xs:element maxOccurs="1" name="acknowledgementResponseCode" type="CodeType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>