Search

Contents

Revindex Storefront

Export Print

RecurringSalesOrder

The RecurringSalesOrder controls the repeat of sales orders.

GetRecurringSalesOrder

This service is used to query the RecurringSalesOrder object.

Request Parameters

Node Required Data Type Description
recurringSalesOrderID Yes Integer The object identifier.

 

Return Data

Node Data Type Description
recurringSalesOrder XML Container node.
  adminNotes String Notes visible to the store administrator only.
  createDate DateTime Creation date.
  cultureCode String The culture code.
  dynamicFormResult XML The result collected from custom fields.
  maxRepeat Integer The number of times this recurring order is allowed to repeat.
  nextRecurringDate DateTime The next recurring date.
  originalSalesOrderID Integer The associated SalesOrder.
  portalID Integer  
  price Decimal Override the calculated price.
  productVariantID Integer The ProductVariant object identifier.
  quantity Integer  
  recurringSalesOrderID Integer The object identifier.
  repeatCount Integer The number of times this recurring order has repeated.
  sellerID Integer Indicates if this object belongs to a seller.
  shippingCity String  
  shippingCompany String  
  shippingCountryCode String  
  shippingCountryName String  
  shippingEmail String  
  shippingFirstName String  
  shippingLastName String  
  shippingMethodID Integer ShippingMethod object identifier.
  shippingPhone String  
  shippingPostalCode String  
  shippingStreet String  
  shippingSubdivisionCode String  
  shippingSubdivisionName String  
  status Integer Recurring order status (Active = 1, Hold = 2, Invalid = 3,
Cancelled = 4)
  updateDate DateTime Update date.
  userID Integer UserID object identifier.
  userPaymentID Integer UserPayment object identifier. The saved user payment to charge for future occurrences of this order.

 


GetRecurringSalesOrders

This service is used to get all the RecurringSalesOrder objects belonging to the portal.

Request Parameters

None

Return Data

Node Data Type Description
recurringSalesOrders XML Container node
  recurringSalesOrder XML Zero or more recurringSalesOrder nodes with same data structure as GetRecurringSalesOrder service return data.

 


GetRecurringSalesOrdersByOriginalSalesOrder

This service is used to get all the RecurringSalesOrder objects belonging to the original sales order.

Request Parameters

Node Required Data Type Description
salesOrderID Yes Integer The object identifier.
 

 

Return Data

Node Data Type Description
recurringSalesOrders XML Container node
  recurringSalesOrder XML Zero or more recurringSalesOrder nodes with same data structure as GetRecurringSalesOrder service return data.
 

 


UpdateRecurringSalesOrder

This service is used to update a RecurringSalesOrder object.

Request Parameters

Node Required Data Type Description
recurringSalesOrderID Yes Integer The object identifier.
status Yes Integer Recurring order status (Active = 1, Hold = 2, Invalid = 3,
Cancelled = 4)
userPaymentID No Integer The saved user payment to charge for future occurrences of this order.

 

Return Data

Same as GetRecurringSalesOrder service return data.

Comments

Add comment

Powered by Revindex Wiki