24/7 Support: 800.608.6482

Navigation

OrderItem_Split

This function splits an order item from an order.

The response contains objects for the original_orderitem as well as the split_orderitem. Specifically the line_id of the split item is returned for storing in an external system

Request Parameters

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
tax Type:
Number		 Title:
Tax		 Sales tax for this specific Item
formatted_tax Type:
String		 Title:
Currency Formatted Tax		 Currency formatted sales tax for this specific Item
upsold Type:
Boolean		 Title:
Upsold		 Upsold
quantity Type:
Number		 Title:
Quantity		 Quantity
total Type:
Number		 Title:
Order Item Total		 Order Item Total
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
id Type:
Number		 Title:
Option ID		 Option ID
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
attr_code Type:
String		 Title:
Base Attribute Code		 Attribute Code
attmpat_id Type:
Number		 Title:
Attribute Template ID		 Attribute Template ID
option_id Type:
Number		 Title:
Option ID		 Option ID
opt_code Type:
String		 Title:
Option Code		 Option Code
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
data Type:
String		 Title:
Option Data		 Option Data up to 255 characters
data_long Type:
String		 Title:
Option Long Data		 Option Long Data (Memo)
attr_prompt Type:
String		 Title:
Attribute Prompt		 Attribute Prompt
opt_prompt Type:
String		 Title:
Option Prompt		 Option Prompt
attribute Type:
String		 Title:
Attribute Code		 Attribute Code
value Type:
String		 Title:
Option Value		 Option Value

Example Request

Example Response

Error Responses

error code:
MER-JSN-ORD-00025		 error message:
Order not found		 description:
Order number not found
error code:
MER-JSN-00023		 error message:
One or more parameters are invalid		 description:
Missing required line_id parameter
error code:
MER-DBP-OIT-00007		 error message:
Record not found		 description:
line_id passed is not valid

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 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.