24/7 Support: 800.608.6482

Get Started

Navigation


Order_Create

This function allows you to create a new order. This function takes input parameters for both items and products. Items allows you to add any item to an order. It does not need to match any existing product in the catalog. When using the products object, Miva will validate that product code exists and load data from that product such as price, weight, name and cost.

Request Body Parameters

Customer_Login Type:
String
Title:
Customer Login
Customer to assign the order to
Customer_ID Type:
Number
Title:
Customer ID
Customer to assign the order to (only customer_login or customer_id can be sent)
Order_Id Type:
Number
Title:
Order ID
[optional] If omitted, Miva will automatically assign an order id to the order.
ShipFirstName Type:
String
Title:
Ship FirstName
FirstName for Ship To address
ShipLastName Type:
String
Title:
Ship LastName
LastName for Ship To address
ShipEmail Type:
String
Title:
Ship Email
Email for Ship To address
ShipPhone Type:
String
Title:
Ship Phone
Phone Number for Ship To address
ShipFax Type:
String
Title:
Ship Fax
Fax Number for Ship To address
ShipCompany Type:
String
Title:
Ship Company
Company Name for Ship To address
ShipAddress1 Type:
String
Title:
Ship Address1
Address line 1 for Ship To address
ShipAddress2 Type:
String
Title:
Ship Address2
Address line 2 for Ship To address
ShipCity Type:
String
Title:
Ship City
City for Ship To address
ShipState Type:
String
Title:
Ship State
State for Ship To Address
ShipZip Type:
String
Title:
Ship Zip
Zip Code for Ship To address
ShipCountry Type:
String
Title:
Ship Country
Country for Ship To Address
ShipFirstName Type:
String
Title:
Bill FirstName
FirstName for Bill To address
ShipLastName Type:
String
Title:
Bill LastName
LastName for Bill To address
ShipEmail Type:
String
Title:
Bill Email
Email for Bill To address
ShipPhone Type:
String
Title:
Bill Phone
Phone Number for Bill To address
ShipFax Type:
String
Title:
Bill Fax
Fax Number for Bill To address
ShipCompany Type:
String
Title:
Bill Company
Company Name for Bill To address
ShipAddress1 Type:
String
Title:
Bill Address1
Address line 1 for Bill To address
ShipAddress2 Type:
String
Title:
Bill Address2
Address line 2 for Bill To address
ShipCity Type:
String
Title:
Bill City
City for Bill To address
ShipState Type:
String
Title:
Bill State
State for Bill To Address
ShipZip Type:
String
Title:
Bill Zip
Zip Code for Bill To address
ShipCountry Type:
String
Title:
Bill Country
Country for Bill To Address
items
+ Show Properties
Type:
Object
Title:
Items
Items
status Type:
Number
Title:
Status
Item Status. 0 = Pending, 100 = Picking, 200 = Shipped, 210 = Gift Certificate: Not Redeemed, 211 = Gift Certificate: Redeemed, 220 = Digital: Not Downloaded, 221 = Digital: Downloaded , 300 = Cancelled, 400 = Backordered, 500 = RMA Issued, 600 = Returned
Code Type:
String
Title:
Code
Item Code
Name Type:
String
Title:
Name
Item Name
SKU Type:
String
Title:
SKU
SKU
tracknum Type:
String
Title:
Tracking Number
[optional] Tracking Number if item is already shipped
tracktype Type:
String
Title:
tracktype
Tracking Type. Default Types include "CanadaPost", "Endicia", "FedEx", "UPS", "USPS".
price Type:
Number
Title:
price
price
weight Type:
Number
Title:
weight
weight
quantity Type:
Number
Title:
quantity
quantity
taxable Type:
Boolean
Title:
taxable
taxable
upsold Type:
Boolean
Title:
upsold
upsold
Options
+ Show Properties
Type:
Object
Title:
Options
Options
opt_code_or_data Type:
String
Title:
Option Code Or Data
[optional] You can pass this value OR opt_code below.
attr_code Type:
String
Title:
Attribute Code
attr_code
opt_code Type:
String
Title:
Option Code
Option Code
Price Type:
Number
Title:
Price
Price
Weight Type:
Number
Title:
Weight
Weight
Products
+ Show Properties
Type:
Object
Title:
Products
Products
status Type:
Number
Title:
Status
Item Status. 0 = Pending, 100 = Picking, 200 = Shipped, 210 = Gift Certificate: Not Redeemed, 211 = Gift Certificate: Redeemed, 220 = Digital: Not Downloaded, 221 = Digital: Downloaded , 300 = Cancelled, 400 = Backordered, 500 = RMA Issued, 600 = Returned
Code Type:
String
Title:
Code
Code
SKU Type:
String
Title:
SKU
SKU
tracknum Type:
String
Title:
tracknum
tracknum
tracktype Type:
String
Title:
tracktype
tracktype
quantity Type:
Number
Title:
quantity
quantity
Attributes
+ Show Properties
Type:
Object
Title:
Attributes
Attributes
code Type:
String
Title:
code
code
template_code Type:
String
Title:
template Code
Attribute Template Code. Empty if not an attribute template is not being used.
Value Type:
String
Title:
Value
Attribute Value
Charges
+ Show Properties
Type:
Object
Title:
Charges
Charges
type Type:
String
Title:
Charge Type
Default Types include: TAX, SHIPPING, DISCOUNT, COUPON
descrip Type:
String
Title:
Charge Description
Charge Description
amount Type:
Number
Title:
amount
amount
display_amount Type:
Number
Title:
Display Amount
Display Amount
tax_exempt Type:
Boolean
Title:
tax exempt
tax exempt
CustomFields
+ Show Properties
Type:
Object
Title:
CustomFields
CustomFields
module_code Type:
String
Title:
Module Code
Module Code, ex: customfields
field_code Type:
String
Title:
Custom Field Code
Custom Field Code
value Type:
String
Title:
Value
Custom Field Value
Shipping_Module_Code Type:
String
Title:
Shipping Module Code
Shipping Module Code
Shipping_module_Data Type:
String
Title:
Shipping Module Data
Typically Shipping Method Name
CalculateCharges Type:
Boolean
Title:
Calculate Charges
Boolean Value to have Miva re-calculate tax and shipping values based on Shipping Module/Method sent.
TriggerFulfillmentModules Type:
Boolean
Title:
Trigger Fulfillment Modules
Boolean Value to have Miva trigger fulfillemnt modules (Send Order Confirmation Emails)

Response Parameters

id Type:
Number
Title:
id
Order Number for the Order
pay_id Type:
Number
Title:
Payment Order ID
Id of Payment Module Used in transaction
batch_id Type:
Number
Title:
Batch ID
Batch ID
status Type:
Number
Title:
Order Status
Order Status. 0 = Pending, 100 = Processing, 200 = Shipped, 201 = Partially Shipped, 300 = Cancelled, 400 = Backordered, 500 = RMA Issued, 600 = Returned
pay_status Type:
Number
Title:
Pay Status
Payment Status. 0 = Pending, 100 = Authorized, 200 = Captured, 201 = Partially Captured
stk_status Type:
Number
Title:
Stock Status
Stock Status. 0 = Pending, 100 = yes, 200 = no, 201 = partial
dt_instock Type:
Unix Timstamp
Title:
Date/Time Instock (Unix timestamp)
Date/Time Instock (Unix timestamp). 0 if Not set
orderdate Type:
Unix Timestamp
Title:
Order Date
Order Date
cust_id Type:
Number
Title:
Customer ID
Customer ID
ship_res Type:
Boolean
Title:
Ship Residential Flag
Ship Residential Flag
ship_fname Type:
String
Title:
Shipping First Name
Shipping First Name
ship_lname Type:
String
Title:
Shipping Last Name
Shipping Last Name
ship_email Type:
String
Title:
Shipping Email Address
Shipping Email Address
ship_comp Type:
String
Title:
Shipping Company
Shipping Company
ship_phone Type:
String
Title:
Shipping Phone Number
Shipping Phone Number
ship_fax Type:
String
Title:
Shipping Fax Number
Shipping Fax Number
ship_addr1 Type:
String
Title:
Shipping Address Line 1
Shipping Address Line 1
ship_addr2 Type:
String
Title:
Shipping Address Line 2
Shipping Address Line 2
ship_city Type:
String
Title:
Shipping City
Shipping City
ship_state Type:
String
Title:
Shipping State
Shipping State
ship_zip Type:
String
Title:
Shipping Zip
Shipping Zip
ship_cntry Type:
String
Title:
Shipping Country
Shipping Country
bill_fname Type:
String
Title:
Billing First Name
Billing First Name
bill_lname Type:
String
Title:
Billing Last Name
Billing Last Name
bill_email Type:
String
Title:
Billing Email Address
Billing Email Address
bill_comp Type:
String
Title:
Bill Company
Bill Company
bill_phone Type:
String
Title:
Billing Phone Number
Billing Phone Number
bill_fax Type:
String
Title:
Billing Fax Number
Billing Fax Number
bill_addr1 Type:
String
Title:
Billing Address Line 1
Billing Address Line 1
bill_addr2 Type:
String
Title:
Billing Address Line 2
Billing Address Line 2
bill_city Type:
String
Title:
Billing City
Billing City
bill_state Type:
String
Title:
Billing State
Billing State
bill_zip Type:
String
Title:
Billing Zip
Billing Zip
bill_cntry Type:
String
Title:
Billing Country
Billing Country
ship_id Type:
Number
Title:
Shipping Module id
Shipping Module Used in Shipping Calculations
ship_data Type:
String
Title:
Shipping Data
Shipping Data - Typically Shipping Method Name
ship_method Type:
String
Title:
Shipping Method
Shipping Method Name
cust_login Type:
String
Title:
Customer Login
Customer Login
cust_pw_email Type:
String
Title:
Customer Email Password
Customer Email Password
business_title Type:
String
Title:
Business Title
Business Title
payment_module Type:
String
Title:
Payment Module
Payment Module Name
source Type:
String
Title:
Source
Source of how the order was placed. Possible Values include "Shopper" - Order Placed By Customer, "Subscription" - Order Created by the Subscription System, "User" - Order Created in the Admin
source_id Type:
Number
Title:
Source ID
The id of the customer, id of Admin user or id of subscription based on how order was placed
total Type:
Number
Title:
Total
Total
formatted_total Type:
String
Title:
Formatted Total
Formatted Total
total_ship Type:
Number
Title:
Total Shipping
Total Shipping
formatted_total_ship Type:
String
Title:
Formatted Total Shipping
Formatted Total Shipping
total_tax Type:
Number
Title:
Total Tax
Total Tax
formatted_total_tax Type:
String
Title:
Formatted Total Tax
Formatted Total Tax
total_auth Type:
Number
Title:
Total Authorized
Total Authorized
formatted_total_auth Type:
String
Title:
Formatted Total Authorized
Formatted Total Authorized
total_capt Type:
Number
Title:
Total Captured
Total Captured
formatted_total_capt Type:
String
Title:
Formatted Total Captured
Formatted Total Captured
total_rfnd Type:
Number
Title:
Total Amount Refunded
Total Amount Refunded
formatted_total_rfnd Type:
String
Title:
Formatted Total Amount Refunded
Formatted Total Amount Refunded
net_capt Type:
Number
Title:
Net Amount Captured
Net Amount Captured
formatted_net_capt Type:
String
Title:
Formatted Net Amount Captured
Formatted Net Amount Captured
pend_count Type:
Number
Title:
Pending Item Count
Pending Item Count
bord_count Type:
Number
Title:
Backordered Item Count
Backordered Item Count
note_count Type:
Number
Title:
Note Count
Note Count
items
+ Show Properties
Type:
Object
Title:
Items
Items
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
status Type:
Number
Title:
Status
Item Status. 0 = Pending, 100 = Picking, 200 = Shipped, 210 = Gift Certificate: Not Redeemed, 211 = Gift Certificate: Redeemed, 220 = Digital: Not Downloaded, 221 = Digital: Downloaded , 300 = Cancelled, 400 = Backordered, 500 = RMA Issued, 600 = Returned
subscrp_id Type:
Number
Title:
Subscription ID
Subscription ID
subterm_id Type:
Number
Title:
Subscription Term Id
Subscription Term Id
rma_id Type:
Number
Title:
Return Merchandise Authorization Id
Return Merchandise Authorization Id
dt_instock Type:
Number
Title:
Date/Time Instock (Unix timestamp)
Date/Time Instock (Unix timestamp)
code Type:
String
Title:
Code
Code
name Type:
String
Title:
Name
Name
sku Type:
String
Title:
Sku Number
Sku Number
retail Type:
Number
Title:
Retail Price
Retail Price
base_price Type:
Number
Title:
Base Price
Base Price
price Type:
Number
Title:
Price
Price
weight Type:
Number
Title:
Weight
Weight
taxable Type:
Boolean
Title:
Taxable
Taxable
upsold Type:
Boolean
Title:
Upsold
Upsold
quantity Type:
Number
Title:
Quantity
Quantity
discounts
+ Show Properties
Type:
Object
Title:
Discounts
Discounts
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
pgrp_id Type:
Number
Title:
Price Group Id
Price Group Id
display Type:
Boolean
Title:
Display
Display
descrip Type:
String
Title:
Description
Description
discount Type:
Number
Title:
Discount Amount
Discount Amount
options
+ Show Properties
Type:
Object
Title:
Options
Options
attribute Type:
String
Title:
Attribute
Attribute
value Type:
String
Title:
Value
Value
weight Type:
Number
Title:
Weight
Weight
retail Type:
Number
Title:
Retail
Retail
base_price Type:
Number
Title:
Base Price
Base Price
price Type:
Number
Title:
Price
Price - Including any item level discounts
discounts
+ Show Properties
Type:
Object
Title:
Discounts
Discounts
order_id Type:
Number
Title:
Order ID
Order ID
line_id Type:
Number
Title:
Line ID
Line ID
attr_id Type:
Number
Title:
Attribute ID
Attribute ID
attmpat_id Type:
Number
Title:
Attribute Template ID
Attribute Template ID
pgrp_id Type:
Number
Title:
Price Group Id
Price Group Id
display Type:
Boolean
Title:
Display
Display
descrip Type:
String
Title:
Description
Description
discount Type:
Number
Title:
Discount Amount
Discount Amount
total Type:
Number
Title:
Total
Total
shipment
+ Show Properties
Type:
Object
Title:
Shipment
Shipment
id Type:
Number
Title:
ID
ID
code Type:
String
Title:
Code
Code
order_id Type:
Number
Title:
Order ID
Order ID
status Type:
Number
Title:
Shipment Status
Shipment Status. 100 = Picking, 200 = Shipped
labelcount Type:
Number
Title:
Label Count
Label Count
ship_date Type:
String
Title:
Ship Date
Ship Date
tracknum Type:
String
Title:
Tracking Number
Tracking Number
tracktype Type:
String
Title:
Tracking Type
Tracking Type. Default Types include "CanadaPost", "Endicia", "FedEx", "UPS", "USPS"
tracklink Type:
String
Title:
Tracking Link
Tracking Link
weight Type:
Number
Title:
Weight
Weight
cost Type:
Number
Title:
Cost
Cost
formatted_cost Type:
String
Title:
Formatted Cost
Formatted Cost
charges
+ Show Properties
Type:
Object
Title:
Charges
Charges
order_id Type:
Number
Title:
Order ID
Order ID
charge_id Type:
Number
Title:
Charge ID
Charge ID
module_id Type:
Number
Title:
Module ID
Module ID
type Type:
String
Title:
Type
Charge Type. Charge types include (but not limited to): "TAX", "SHIPPING" , "DISCOUNT", "HANDLING". Its possible for custom charge types to exist.
descrip Type:
String
Title:
Description
Description
amount Type:
Number
Title:
Amount
Amount
disp_amt Type:
Number
Title:
Display Amount
Display Amount
tax_exempt Type:
Number
Title:
Tax Exempt
Tax Exempt
CustomField_Values Type:
Object
Title:
Custom Field Values
Array of custom field modules. Each module will have its own children of name/value pairs for order custom fields.

Example Request

Example Response

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

Copyright © 1997 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.