24/7 Support: 800.608.6482

Navigation


OrderItem_Add

This function allows you to add an item (product) to an order

Request Body Parameters

order_id Type:
Number
Title:
Order Id
Order Id to add item to
code Type:
String
Title:
Product Code
Product Code to Add (this does not need to exist as a product in Miva's Database)
name Type:
String
Title:
Product Name
Product Name
sku Type:
String
Title:
Product SKU
Product SKU
quantity Type:
Number
Title:
Quantity
Product Quantity
weight Type:
Number
Title:
Weight
Weight
Taxable Type:
Boolean
Title:
Taxable
Taxable
attributes
+ Show Properties
Type:
Object
Title:
attributes
Attributes
attr_code Type:
Number
Title:
Attribute Code
Attribute Code
opt_code_or_data Type:
String
Title:
Option Code/Data
Option Code/Data. You can use this parameter or opt_code. Both are not required.
opt_code Type:
String
Title:
Option Code
Option Code
price Type:
Number
Title:
Price
Price
weight Type:
Number
Title:
Weight
Weight

Response Parameters

total Type:
Number
Title:
Order Total
Order Total after new item has been added.
formatted_total Type:
String
Title:
Formatted Order Total
Currenty Formatted Order Total
orderitem
+ Show Properties
Type:
Object
Title:
Order Item
Record for newely created order item

Example Request

Example Response

Error Responses

error code
MER-JSN-ORD-00025
error message
Order not found
  Order number not found.

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.