24/7 Support: 800.608.6482

Get Started

Developer Docs

Order_Add

Add an order in Miva.
Element Xpath Required Occurs Type Description
Order_Add Yes 1 Container Node Top-level container.
Order_Add/ID No 1 Integer Node Explicitly set order id. If omitted, order id will be autogenerated based off current highest store order id.
Order_Add/OrderDate No 1 Container Node Container node for order date.
Order_Add/OrderDate/Day Yes* 1 Integer Node Order date day of the month.
Order_Add/OrderDate/Month Yes* 1 Integer Node Order date month of the year.
Order_Add/OrderDate/Year Yes* 1 Integer Node Order date year.
Order_Add/OrderDate/Hour No 1 Integer Node Order date hour.
Order_Add/OrderDate/Minute No 1 Integer Node Order date minute of the hour.
Order_Add/OrderDate/Second No 1 Integer Node Order date second of the minute.
Order_Add/CustomerLogin No 1 Text Node Link order to existing customer account via customer login identifier.
Order_Add/ShipResidential No 1 Text Node

Is residential shipping address flag.

yes = True value.

no = False value.

Order_Add/ShipFirstName No 1 Text Node Shipping address first name.
Order_Add/ShipLastName No 1 Text Node Shipping address last name.
Order_Add/ShipEmail No 1 Text Node Shipping address email address.
Order_Add/ShipCompany No 1 Text Node Shipping address company name.
Order_Add/ShipPhone No 1 Text Node Shipping address phone number.
Order_Add/ShipFax No 1 Text Node Shipping address fax number.
Order_Add/ShipAddress1 No 1 Text Node Shipping address street line 1.
Order_Add/ShipAddress2 No 1 Text Node Shipping address street line 2.
Order_Add/ShipCity No 1 Text Node Shipping address city.
Order_Add/ShipState No 1 Text Node Shipping address state code. Example: CA for California.
Order_Add/ShipZip No 1 Text Node Shipping address postal code.
Order_Add/ShipCountry No 1 Text Node

Shipping address country code. ISO 3166-1 alpha-2 format.

Example: ISO 3166-1 alpha-2 for United States.

Order_Add/BillFirstName No 1 Text Node Billing address first name.
Order_Add/BillLastName No 1 Text Node Billing address last name.
Order_Add/BillEmail No 1 Text Node Billing address email address.
Order_Add/BillCompany No 1 Text Node Billing address company name.
Order_Add/BillPhone No 1 Text Node Billing address phone number.
Order_Add/BillFax No 1 Text Node Billing address phone number.
Order_Add/BillAddress1 No 1 Text Node Billing address street line 1.
Order_Add/BillAddress2 No 1 Text Node Billing address street line 2.
Order_Add/BillCity No 1 Text Node Billing address city.
Order_Add/BillState No 1 Text Node

Billing address state code.

Example: CA for California.

Order_Add/BillZip No 1 Text Node Billing address postal code.
Order_Add/BillCountry No 1 Text Node

Billing address country code.

ISO 3166-1 alpha-2 format.

Example: US for United States.

Order_Add/Items No 1 Container Node Container for order items list.
Order_Add/Items/Item No 1+ Container Node Container for order item.
Order_Add/Items/Item/Code Yes* 1 Text Node Order item product code.
Order_Add/Items/Item/Name Yes* 1 Text Node Order item name.
Order_Add/Items/Item/Price No 1 Decimal Node Order item price.
Order_Add/Items/Item/Weight No 1 Decimal Node Order item weight.
Order_Add/Items/Item/Options No 1 Container Node Order item options list.
Order_Add/Items/Item/Options/Option No 1+ Container Node Order item attributes and attribute options list.
Order_Add/Items/Item/Options/Option /AttributeCode Yes* 1 Text Node Order item attribute code.
Order_Add/Items/Item/Options/Option/Price No 1 Decimal Node Additional cost for order item attribute.
Order_Add/Items/Item/Options/Option/Value No 1 Text Node Order item attribute option value.
Order_Add/Charges No 1 Container Node Container for order charges list.
Order_Add/Charges/Charge No 1+ Container Node Container for order charge.
Order_Add/Charges/Charge/Type Yes* 1 Container Node

Order charge type.

Examples: TAX, SHIPPING, DISCOUNT

Order_Add/Charges/Charge/Description Yes* 1 Container Node Order charge description.
Order_Add/Charges/Charge/Amount Yes* 1 Decimal Node Order charge amount.

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Miva believes that all online businesses should have access to a scalable ecommerce platform that can meet their unique business requirements. Miva offers PCI compliant ecommerce, hosting, and custom website design and development solutions. Miva customers have processed over $100 billion in online sales since 1997.

Copyright © 2016 Miva, Inc - All Rights Reserved   Privacy Policy | Store Policy

Links
Contact Us
Receive Tips & Updates

Copyright © 2017 Miva, Inc - All Rights Reserved

Back To The Top