Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 3.33 KB

File metadata and controls

51 lines (39 loc) · 3.33 KB

AutoOrder

Properties

Name Type Description Notes
addOns List<AutoOrderAddonItem> Array of addon objects instructing which items to add to auto order and how many times they should be added. [optional]
autoOrderCode String Unique code assigned to this auto order [optional]
autoOrderOid Integer Auto order object identifier [optional]
cancelAfterNextXOrders Integer Cancel this auto order after X additional rebills [optional]
cancelDowngrade Boolean True if the auto order was canceled because the customer purchased a downgrade item [optional]
cancelReason String The reason this auto order was canceled by either merchant or customer [optional]
cancelUpgrade Boolean True if the auto order was canceled because the customer purchased an upgrade item [optional]
canceledByUser String The user that canceled the auto order [optional]
canceledDts String The date/time that the auto order was canceled [optional]
completed Boolean True if the auto order ran successfully to completion [optional]
creditCardAttempt Integer The number of credit card attempts that have taken place [optional]
disabledDts String The date/time the auto order was disabled due to failed rebills [optional]
enabled Boolean True if this auto order is enabled [optional]
failureReason String The reason this auto order failed during the last rebill attempt [optional]
items List<AutoOrderItem> The items that are setup to rebill [optional]
logs List<AutoOrderLog> Logs associated with this auto order [optional]
management AutoOrderManagement [optional]
merchantId String UltraCart merchant ID owning this order [optional]
mergedDts String The date/time the auto order was merged into another auto order [optional]
mergedIntoAutoOrderOid Integer The auto order that this auto order was merged into [optional]
nextAttempt String The next time that the auto order will be attempted for processing [optional]
originalOrder Order [optional]
originalOrderId String The original order id that this auto order is associated with. [optional]
overrideAffiliateId Integer Override the affiliate id given credit for rebills of this auto order [optional]
properties List<AutoOrderProperty> Array of property objects [optional]
rebillOrders List<Order> Rebill orders that have taken place on this auto order [optional]
rotatingTransactionGatewayCode String The RTG code associated with this order for future rebills [optional]
status StatusEnum The status of the auto order [optional]

Enum: StatusEnum

Name Value
ACTIVE "active"
CANCELED "canceled"
DISABLED "disabled"
MERGED "merged"