A single order to be imported into ShipWorks. The numeric, unique order number identifying this order to ShipWorks. Extra text to apply to the order number before OrderNumber. Useful for creating grouped/split orders. Extra text to apply to the order number after OrderNumber. Useful for creating grouped/split orders. The date and time the order was originally placed. The time is in UTC. The date and time the order was last modified in the online store, by the end customer or staff. The time is in UTC. Required if DownloadStrategy is defined as ByModifiedTime. Customer-requested shipping method for the order. This is displayed in ShipWorks and should be human-readable. The status code for the current status of the order. Required when OnlineStatus is designated as supported. See complexType Module. The channel order id of the order. The ship by date of the order. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. Custom field for importing additional order data. A value uniquely identifying the purchasing customer to ShipWorks. Required when OnlineCustomerID is designated as supported. See complexType Module. A collection of any number of notes to attach to the order in ShipWorks. The shipping address specified on the order. The billing address specified on the order. The Amazon order information on the order. Container for payment information provided by the customer. This information is displayed on the Payments panel in the ShipWorks user interface. Payment method displayed in ShipWorks. If the Method of payment is some type of credit card, the cc information can be supplied here. The type of credit card, displayed to the user. The name listed as the owner of the card. Credit card number provided by the customer. If your integration allows unsecured connections, this value should not be provided in whole to ShipWorks. Card expiration date. Card verification number, on the back of the card. Once again, this value should not be provided to ShipWorks if communication is detected to be unsecure. Used to specify other payment details, gift certificates or reward cards for example. The name of the payment detail item displayed in ShipWorks. Items are displayed as "Name: Value". For example "Discount Code: ABCDEFG" The value of the payment detail item displayed in ShipWorks. Items are displayed as "Name: Value". For example "Discount Code: ABCDEFG" The purchased items on the order; line items. Charges and fees applied to the order that impact its total cost. A single charge, fee, or discount that impacts the order total. The monetary value of this charge. Do not use negative numbers to apply discounts. Rather, use the impact attribute to specify how a value impacts the total. An identifier for the charge in your system, if desired. Display text for the fee or charge. Ex. Shipping and Handling A code for the charge that can be keyed on in Templates, if desired. Ex. HANDLING Specifies how the value of this charge impacts the order total. Possible values are: add, subtract, and none. Debugging and support data not processed by ShipWorks, but recorded in logs. Requested warehouse to send the order to. A distinct purchased item on an order. Also referred to as a Line Item or Order Item. Identifier of the item in your system, if desired. Value that uniquely identifies the item purchased. Another value to identify the purchased item. Stock Keeping Unit for the item. Universal Product Code for the item. International Standard Book Number for the item. Description of the item. Status of the item. Display text for the item. Number of these items purchased. This value is multiplied by UnitPrice and Weight when calculating total order cost and weight. The price of a single one of these items. This value is multiplied by Quantity when total order value is calculated. The cost of a single one of these items. This value is multiplied by Quantity when total order cost is calculated. The URL to the full product image. This will allow an image of the item to be placed on invoices and reports. The URL to the product thumbnail image. This will allow the thumbnail image of the item to be placed on invoices and reports. The weight of a single one of these items. This value is multiplied by Quantity when the total order weight is calculated. The length of a single one of these items. The width of a single one of these items. The height of a single one of these items. The Amazon information for this item. Typically the stock location of the item in a warehouse. The brand of a single one of these items. The Manufacturer Part Number of a single one of these items. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Custom field for importing additional order item data. Attributes are for product variations or options selected by the customer. Ex. size, color, edition. Debugging and support data not processed by ShipWorks, but recorded in logs. Declares a chosen product option or variation. Identifier of the option or variation in your system, if desired. Display text for the option or variation type. Ex. Size, Color, Edition The customer-chosen value for the option or variation. Ex. Small, Red, Special The charge for the option or variation. This value impacts the calculated order total in ShipWorks. Debugging and support data not processed by ShipWorks, but recorded in logs. A textual note attached to orders. The date the note or comment was applied. Public notes are printed on invoices, for customer comments and the like. Private notes are those entered and viewable by store staff, as they are considered internal in nature. Container for Amazon order information. Indicates whether an order is an Amazon Prime order. Indicates whether an order is Fulfilled by Amazon (FBA). The Amazon order ID. Ex. 000-1234567-1234567 Indicates whether an order is a Seller Fulfilled Prime (SFP) same day order. Container for Amazon item information. The Amazon order item code. Ex. 12345678901234 Container for address information. The addressee's name. The addressee's company name. Street address. Street address. Street address. The addressee's city. The addressee's state code. The addressee's postal code. The addressee's country code. Indicator for this being a residential address. This is used to configure how shipments are processed and rated. Teh addressee's phone number. The addressee's fax number. The addressee's email address. The addressee's website URL. A person's name broken out into its first, middle, and last name. A person's name. When present, ShipWorks will parse the name into its first, middle, and last names. Describes a version string in the format x.y.z Defines how an item impacts the total. A non-empty string. Data types allowed for a the variable pieces of data such as StatusCode and CustomerID. Root of all integration responses. Container for echoing received parameters back to ShipWorks. Useful for support staff. Response element for GetModule call. Response element for GetStore call. Response element for GetStatusCodes call. Response element for GetCount call. Response element for GetOrders call. Response element for a successful UpdateStatus or UpdateShipment call. Response element for any fatal errors that occured in the processing of any requests. The error code will appear in logs and has no meaning to ShipWorks. Error message that will be presented to the user when encountered by ShipWorks. Container for passing any debugging or support information back to ShipWorks. Nothing contained here will be used by ShipWorks. Responses will be logged by ShipWorks, so this should not contain sensitive information. The version of this integration module. Must be at least 3.0.0 for ShipWorks 3, or an error will be raised. ShipWorks Schema version to validate the response to. Currently 1.0.0. Demographic information about the user's online store. This information is made available to the ShipWorks user during shipping and invoicing. The name of the online store. The individual or company owner's name. Typically the support/customer service email address for the store. Physical street address. Physical street address. Physical street address. City where the store is located. State where the store is located. State code or full name. Postal code where the store is located. Country where the store is located. Country code or full name. Typically the store's customer service phone number. The online store's customer-facing URL. Descriptive information about the module and its developer, including the module's capabilities. The ecommerce system this module allows ShipWorks to integrate with. The company or individual name of the integration developer. Declares the functionality available in the integration. Options specified here setup expectations in ShipWorks such as the availability of certain data elements, or features as a whole. Dictates how ShipWorks will retrieve orders from your system. ByModifiedTime: ShipWorks will request orders placed or modified since the most recent LastModified order it has downloaded in the past. ByOrderNumber: ShipWorks will request orders having order numbers larger than the highest order number it has downloaded in the past. Consult the Store Integration Guide for more information on the implications of this setting. ShipWorks will request orders placed or modified since the most recent LastModified order it has downloaded in the past. ShipWorks will request orders having order numbers larger than the highest order number it has downloaded in the past. If your system assigns unique identifier to customers, ShipWorks can use this identifier to match up orders to customers in the ShipWorks database. Customer linking is done by email address otherwise. Specifies whether or not CustomerID will be provided in GetOrder response. Tells ShipWorks what type of data to expect in the CustomerID element of the GetOrder response. ShipWorks can do more than just display order statuses. Depending on the configuration specified here, ShipWorks can allow users to change order status with or without comments. Specifies whether or not order statuses should be downloaded and displayed. Specifies if ShipWorks users can provide comments when doing order status updates. Ignored if downloadOnly is true. Specifies if order statuses are read-only, not allowing the user to make changes to the online status. If this is true, no UpdateStatus calls will ever be made by ShipWorks. Tells ShipWorks what type of data to expect in the StatusCode element of the GetOrder response. ShipWorks can send shipment tracking information to the integration, either automatically when orders are shipped or manually by the user. Dictates whether or not shipment details should be sent to the integration. If this is true, no UpdateShipment calls will ever be made by ShipWorks. This is used to configure any communications-level settings ShipWorks needs in order to fully communicate with the module. By default ShipWorks will send the expect:100Continue HTTP Header on its POST requests. If this causes issues for your system, set this to false and it will no longer be sent. The character encoding used in responses from the integration. By default ShipWorks expects UTF-8, but can support Latin-1 (ISO-8859-1) by configuring this. ShipWorks default Also known as ISO-8859-1 Container element for a single status code. The internal representation of your system's status code. For example 1001, SHIP, CANCEL2 The display name for the status code. This value is presented as the status code in ShipWorks and should be identical to how it is displayed in your system to avoid confusion.